diff --git a/.github/ISSUE_TEMPLATE/broken-link-or-update.yml b/.github/ISSUE_TEMPLATE/broken-link-or-update.yml new file mode 100644 index 0000000..aa53f0f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/broken-link-or-update.yml @@ -0,0 +1,42 @@ +name: Broken Link or Outdated Resource +description: Report a dead link, moved resource, or something that needs updating +title: "[Fix] Broken/Outdated: Brief description" +labels: ["maintenance", "bug"] +body: + - type: input + id: url + attributes: + label: Problematic URL + validations: + required: true + + - type: input + id: location + attributes: + label: Where is this link located? + placeholder: e.g., README.md line 456, or ./hacking-pentesting/wordlists.md + + - type: dropdown + id: issue_type + attributes: + label: Type of Issue + options: + - 404 / Not Found + - 403 / Forbidden + - Redirected / Moved + - Outdated / Deprecated + - Better Alternative Exists + - Other + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested Fix / Replacement + placeholder: "Replace with https://new-working-url.com (status 200); or remove if obsolete." + + - type: textarea + id: context + attributes: + label: Additional Context diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..2ec26ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false # Disable "Open a blank issue" to encourage template use +contact_links: + - name: General Questions or Discussions + url: https://github.com/jacob-kraniak/the-book-of-secret-knowledge/discussions + about: For questions, ideas, or open discussion — please use Discussions instead of issues. + - name: Contact Maintainer (Jacob) + url: https://x.com/JacobSk92 + about: For private or urgent outreach. diff --git a/.github/ISSUE_TEMPLATE/general-enhancement.yml b/.github/ISSUE_TEMPLATE/general-enhancement.yml new file mode 100644 index 0000000..7cc011b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general-enhancement.yml @@ -0,0 +1,20 @@ +name: General Enhancement or Idea +description: Propose any other improvement (navigation, formatting, new feature like search, etc.) +title: "[Enhancement] Short title" +labels: ["enhancement"] +body: + - type: textarea + id: description + attributes: + label: Description of the Enhancement + value: | + **Is your feature request related to a problem? Please describe.** + A clear and concise description of what the problem is. + + **Describe the solution you'd like** + A clear and concise description of what you want to happen. + + **Additional context** + Add any other context or screenshots about the feature request here. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question-or-discussion.md b/.github/ISSUE_TEMPLATE/question-or-discussion.md new file mode 100644 index 0000000..50104d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-or-discussion.md @@ -0,0 +1,18 @@ +--- +name: Question or Open Discussion +description: Have a question or want to discuss something? → Use Discussions instead! +title: "[Discussion] " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Thanks for wanting to start a conversation! + + For questions, brainstorming, or non-actionable discussion, please use **GitHub Discussions** instead: + + 👉 https://github.com/jacob-kraniak/the-book-of-secret-knowledge/discussions/new + + This helps keep Issues focused on actionable work (bugs, features, migrations). + + You can close this issue now — or comment if you really prefer it here. diff --git a/.github/ISSUE_TEMPLATE/resource-suggestions.yml b/.github/ISSUE_TEMPLATE/resource-suggestions.yml new file mode 100644 index 0000000..47c8d2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/resource-suggestions.yml @@ -0,0 +1,76 @@ +name: Resource Suggestion +description: Suggest adding or updating a tool, link, blog, cheat sheet, one-liner, etc. +title: "[Resource] Short descriptive title" +labels: ["resource", "enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a resource! Please fill out as much as possible. + + - type: input + id: name + attributes: + label: Resource Name + description: Name of the tool, blog, list, one-liner collection, etc. + placeholder: e.g., "nmap", "PayloadsAllTheThings", "Shell One-liner: Find large files" + validations: + required: true + + - type: input + id: url + attributes: + label: URL / Location + description: Direct link (or file path if already in repo) + placeholder: https://example.com/tool or ./shell-utils/one-liners/find-large-files.md + validations: + required: true + + - type: dropdown + id: category + attributes: + label: Which section/category does this belong to? + options: + - CLI Tools + - GUI Tools + - Web Tools + - Systems & Services + - Networks + - Containers & Orchestration + - Manuals / Howtos / Tutorials + - Inspiring Lists + - Blogs / Podcasts / Videos + - Hacking / Penetration Testing + - Daily Knowledge / News + - Cheat Sheets + - Shell One-liners / Tricks / Functions + - Other (please specify below) + default: 0 + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description & Why Include It + description: Brief summary + why it's valuable / unique / up-to-date. + placeholder: "nmap is the de facto network scanner; still actively maintained in 2026." + validations: + required: true + + - type: input + id: tags + attributes: + label: Suggested Tags / Keywords + description: Comma-separated (helps future search/tagging) + placeholder: nmap, scanning, network, cli + + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have searched existing resources / issues to avoid duplicates + required: true + - label: The resource is legal, ethical, and publicly available + required: true diff --git a/.github/ISSUE_TEMPLATE/section-migration.yml b/.github/ISSUE_TEMPLATE/section-migration.yml new file mode 100644 index 0000000..27f855a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/section-migration.yml @@ -0,0 +1,47 @@ +name: Section Migration / Restructure +description: Propose or work on moving a README section to subfolder/files +title: "[Migration] Move/Refactor: Section Name" +labels: ["migration", "structural", "help wanted"] +body: + - type: markdown + attributes: + value: | + Use this for tracking the big structural refactor (moving content from README.md into dedicated folders/files). + + - type: input + id: section + attributes: + label: Section / Subsection to Migrate + placeholder: e.g., CLI Tools → Network subsection, or Hacking/Penetration Testing → Labs & CTFs + validations: + required: true + + - type: input + id: target + attributes: + label: Proposed Target Location + placeholder: e.g., /cli-tools/network.md or /hacking-pentesting/labs-ctfs.md + validations: + required: true + + - type: textarea + id: notes + attributes: + label: Migration Notes / Decisions + description: Any consolidation, deduplication, renaming, or special handling needed? + placeholder: "Consolidate multiple CTF/lab mentions into one file; remove 404 links; add YAML frontmatter for tags." + + - type: textarea + id: blockers + attributes: + label: Potential Blockers or Dependencies + placeholder: "Depends on folder skeleton being created first; needs review of overlapping sections." + + - type: checkboxes + id: status + attributes: + label: Current Status (self-check) + options: + - label: This is a proposal (not yet started) + - label: In progress (link PR below if exists) + - label: Ready for review