From 165ed3a8925942707d6fd275ea7d0a475266cb06 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 24 Jun 2026 07:00:26 +0000 Subject: [PATCH] feat(github): add issue templates (salvaged from superseded #41) PR #41 (estate-standardization-20260607) is ~fully superseded by current main: a faithful integration nets to only these issue templates (everything else already landed via #37-#40 + later work; its 6a2/ files were regressive). Salvage the one useful delta. bug_report.md and feature_request.md are #41's clean classic templates; question and documentation were malformed in #41 (classic front-matter + raw issue-forms YAML in one .md) and are fixed here into proper .yml issue forms. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01WN6nPWWe4dvXfoqBG6auWN --- .github/ISSUE_TEMPLATE/bug_report.md | 42 ++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.yml | 54 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++ .github/ISSUE_TEMPLATE/question.yml | 44 ++++++++++++++++++ 4 files changed, 164 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..45a6c02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,42 @@ + +--- +name: Bug report +about: Create a report to help us improve +title: "[Bug]: " +labels: 'bug, priority: unset, triage' +assignees: '' + +--- + +**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. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..1e12e86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,54 @@ +# SPDX-License-Identifier: MPL-2.0 +# Copyright (c) Jonathan D.A. Jewell +name: Documentation +description: Report unclear, missing, or incorrect documentation +title: "[Docs]: " +labels: ["documentation", "triage"] +body: + - type: markdown + attributes: + value: | + Help us improve our documentation by reporting issues or gaps. + - type: dropdown + id: type + attributes: + label: Documentation issue type + options: + - Missing (documentation doesn't exist) + - Incorrect (information is wrong) + - Unclear (confusing or hard to follow) + - Outdated (no longer accurate) + - Typo or grammar + validations: + required: true + - type: input + id: location + attributes: + label: Location + description: Where is this documentation? (URL, file path, or section name) + placeholder: README.adoc, section "Installation" + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: What's the problem with the current documentation? + placeholder: Describe what's wrong or missing + validations: + required: true + - type: textarea + id: suggestion + attributes: + label: Suggested improvement + description: How should it be fixed or improved? + placeholder: The documentation should say... + validations: + required: false + - type: checkboxes + id: contribution + attributes: + label: Contribution + options: + - label: I would be willing to submit a PR to fix this + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a5a5693 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ + +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement, priority: unset, triage' +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/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..1835842 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,44 @@ +# SPDX-License-Identifier: MPL-2.0 +# Copyright (c) Jonathan D.A. Jewell +name: Question +description: Ask a question about usage or behaviour +title: "[Question]: " +labels: ["question", "triage"] +body: + - type: markdown + attributes: + value: | + Have a question? You can also ask in [Discussions](../discussions) for broader conversations. + - type: textarea + id: question + attributes: + label: Your question + description: What would you like to know? + placeholder: How do I...? + validations: + required: true + - type: textarea + id: context + attributes: + label: Context + description: Any relevant context that helps us answer your question + placeholder: I'm trying to achieve X and I've tried Y... + validations: + required: false + - type: textarea + id: research + attributes: + label: What I've already tried + description: What have you already looked at or attempted? + placeholder: I've read the README and searched issues but... + validations: + required: false + - type: checkboxes + id: checked + attributes: + label: Pre-submission checklist + options: + - label: I have searched existing issues and discussions + required: true + - label: I have read the documentation + required: true