From c9a9b04fd714395f45a4b7c03feaacaf2653319a Mon Sep 17 00:00:00 2001 From: Lasse Nielsen Date: Sun, 1 Mar 2026 17:02:57 +0100 Subject: [PATCH] docs: add issue templates and PR template --- .github/ISSUE_TEMPLATE/bug-report.yml | 63 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature-request.yml | 35 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 36 +++++++++++++ 4 files changed, 135 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..cbf6ea4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,63 @@ +name: Bug Report +description: Report a bug with RaidLogAuto +title: "[Bug]: " +labels: + - bug +body: + - type: textarea + id: description + attributes: + label: Description + description: Clear description of the bug + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Numbered steps to trigger the bug + placeholder: | + 1. Open the game + 2. Do something specific + 3. ... + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What should happen + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: What actually happens (include errors) + validations: + required: true + - type: dropdown + id: wow-version + attributes: + label: WoW Version + description: Which version of World of Warcraft are you playing? + options: + - Retail + - TBC Anniversary + - MoP Classic + validations: + required: true + - type: input + id: raid-log-auto-version + attributes: + label: RaidLogAuto Version + description: 'Version number or "latest"' + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Screenshots, error logs, addon list + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..f4d0e9f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,35 @@ +name: Feature Request +description: Suggest a new feature or improvement for RaidLogAuto +title: "[Feature]: " +labels: + - enhancement +assignees: [] +body: + - type: textarea + id: problem-motivation + attributes: + label: Problem / Motivation + description: What problem does this solve? + validations: + required: true + - type: textarea + id: proposed-solution + attributes: + label: Proposed Solution + description: Describe the desired feature or API + validations: + required: true + - type: textarea + id: alternatives-considered + attributes: + label: Alternatives Considered + description: Other approaches you've considered + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Examples, references, mockups + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..397dabc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ +## Description + + + +## Type of Change + + + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Refactor (non-breaking change that improves code quality) +- [ ] Documentation update +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Related Issues + + + +## Testing + + + +- [ ] Luacheck passes (`luacheck .`) +- [ ] Tested in-game manually +- [ ] WoW version(s) tested on: + +## Screenshots + + + +## Checklist + +- [ ] My code follows the project's code style (4-space indent, 120 char lines) +- [ ] I have tested my changes in-game +- [ ] Luacheck reports no warnings +- [ ] My commits follow [conventional commit](https://www.conventionalcommits.org/) format