diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 9176b45..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: awaiting review, bug -assignees: StrangeRanger - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Setup (please complete the following information):** -- Linux Distro/Version: [e.g. Ubuntu 24.04] -- Script(s) Name: [e.g. `sshd.bash`] -- Script(s) Version: [e.g. v1.0.0] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..6266beb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,69 @@ +name: Bug report +description: Report a problem with an auditing or hardening script, or its documentation. +labels: ["awaiting review", "bug"] +assignees: ["StrangeRanger"] + +body: + - type: dropdown + id: component + attributes: + label: Affected script or documentation + description: Select all that apply. + multiple: true + 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. + 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. + 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. + 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. + placeholder: | + Linux distribution and release: + Bash version (bash --version): + Script version and/or repository commit: + + - 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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..06fdc3f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Script documentation + url: https://github.com/StrangeRanger/linux-security-scripts#tools-and-scripts + about: Review requirements, usage, and compatibility for each script. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a703c23..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: awaiting review, enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..d04ee67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,62 @@ +name: Feature request +description: Suggest a script improvement, new auditing or hardening script, or documentation change. +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 + - 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 + 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. + 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. + 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. + + - type: textarea + id: context + attributes: + label: Additional context + description: Link relevant upstream documentation, audit recommendations, or related issues.