Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 38 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,69 +1,82 @@
name: Bug report
description: Report a problem with an auditing or hardening script, or its documentation.
name: Bug Report
description: Report a problem with an auditing or hardening script.
labels: ["awaiting review", "bug"]
assignees: ["StrangeRanger"]

body:
- type: dropdown
id: component
attributes:
label: Affected script or documentation
description: Select all that apply.
multiple: true
label: Affected Script
description: Select the script involved.
options:
- Lynis Installer
- Root Locker
- SSHD Hardening
- UFW Cloudflare
- Nginx WAF
- Documentation or repository
validations:
required: true

- type: textarea
id: problem
attributes:
label: What went wrong?
description: Describe the expected result, actual behavior, and impact on auditing, system access, or a service.
label: Bug Description
description: Describe the problem and its impact.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Note whether this was a first or repeat run and whether it was interrupted.
label: Steps to Reproduce
description: Describe the steps that led to the problem. Include the command you ran, relevant configuration details, and your responses to any prompts.
placeholder: |
1.
2.
3.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Describe what you expected to happen.
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: Describe what actually happened, including any changes to configurations, system access, or service availability.
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant output
description: Paste sanitized output, including the first error and surrounding lines, and the exit status if known. No code fences needed.
label: Relevant Output
description: Paste relevant output, including the first error and surrounding lines.
render: text

- type: textarea
id: environment
attributes:
label: Environment
description: |
Include details relevant to the failure. Find the script version in its `# Version:` header.
For Nginx build failures, include sanitized `nginx -V` output and the Nginx installation source.
Include details relevant to the failure. You can find the script version in its `# Version:` header.
Describe any local changes to the script. Include the versions of affected software, such as OpenSSH, UFW, or Nginx.
For Nginx build failures, include sanitized `nginx -V` output. Specify how Nginx was installed.
placeholder: |
Linux distribution and release:
Bash version (bash --version):
Script version and/or repository commit:
Script version:
Repository commit (if known):
Relevant software versions:
Local script changes:

- type: textarea
id: context
attributes:
label: Additional context
description: |
Link related issues or describe when this last worked. Include only relevant, sanitized excerpts.
Useful details depend on the script:
- Lynis Installer: destination and whether it already existed; distinguish installer failures from later Lynis audit results.
- Root Locker: root password lock status and whether non-root sudo access still works.
- SSHD Hardening: relevant settings/includes, service name (ssh/sshd), and whether new SSH logins work.
- UFW Cloudflare: before/after rules, IPv4/IPv6 behavior, range download errors, and Cloudflare versus direct origin access.
- Nginx WAF: failing stage, reused build directories, configuration check results, and rule IDs for blocked requests.
label: Additional Context
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Documentation
description: Suggest corrections, clarifications, or additions to the documentation.
labels: ["awaiting review", "documentation"]

body:
- type: dropdown
id: scope
attributes:
label: Scope
description: Select the type of change you are requesting.
options:
- Correct existing information
- Clarify existing instructions
- Add missing content
validations:
required: true

- type: textarea
id: location
attributes:
label: Affected Documentation
description: Identify the section that needs attention, including its file path. For new documentation, describe the topic it should cover.
placeholder: "For example: hardening/SSHD Hardening/README.md, Usage section."
validations:
required: true

- type: textarea
id: problem
attributes:
label: Reason for the Change
description: Explain why the documentation needs updating. Describe what you were trying to accomplish. If you followed the instructions, explain where you got stuck.
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed Solution
description: Describe the changes you suggest. Include a draft revision if you have one.
validations:
required: true

- type: textarea
id: context
attributes:
label: Additional Context
36 changes: 19 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,62 +1,64 @@
name: Feature request
description: Suggest a script improvement, new auditing or hardening script, or documentation change.
name: Feature Request
description: Propose a new script or improvements to an existing one.
labels: ["awaiting review", "enhancement"]
assignees: ["StrangeRanger"]

body:
- type: dropdown
id: scope
attributes:
label: Scope
multiple: true
options:
- Improve an existing script
- Add a new standalone script
Comment on lines 9 to 12
- Improve documentation or repository tooling
validations:
required: true

- type: dropdown
id: component
attributes:
label: Affected script or documentation
description: Select all that apply. Choose N/A if no existing script or documentation applies.
multiple: true
label: Affected Script
description: Select the affected script. Choose 'N/A' if you are requesting a new script.
options:
- Lynis Installer
- Root Locker
- SSHD Hardening
- UFW Cloudflare
- Nginx WAF
- Documentation or repository
- N/A
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem or use case
description: Describe the task you need to accomplish, who would benefit, and what the current scripts or documentation do not address.
label: Problem or Use Case
description: Describe the task you need to accomplish. Explain who would benefit from the change and why the current scripts do not meet their needs.
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed behavior
description: Describe how the feature should work from the user's perspective. Include an example command, prompt, configuration change, or expected output if helpful.
label: Proposed Solution
description: Describe your proposed change. For a new script, explain the auditing or hardening task it should perform.
validations:
required: true

- type: textarea
id: requirements
attributes:
label: Target Environment and Requirements
description: List the Linux distributions, releases, and software versions the change should support, if known. Note any required privileges and dependencies. Identify any existing configuration that must be preserved.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe current workarounds, manual steps, or existing tools you considered and why they do not meet this use case.
label: Alternatives Considered
description: Describe the alternatives you considered, such as workarounds, manual steps, or existing tools. Explain why they do not meet your needs.

- type: textarea
id: context
attributes:
label: Additional context
description: Link relevant upstream documentation, audit recommendations, or related issues.
label: Additional Context
Loading