diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..511bdca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,80 @@ +name: Bug report +description: Report something that is not working as expected. +title: "bug: " +labels: + - bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug. + + - type: textarea + id: description + attributes: + label: Description + description: Describe the problem clearly and concisely. + placeholder: What happened? + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen? + placeholder: I expected... + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Provide the steps needed to reproduce the issue. + placeholder: | + 1. Go to ... + 2. Click on ... + 3. Enter ... + 4. See error ... + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Include any relevant environment information. + placeholder: | + OS: macOS 15 + Browser: Chrome 140 + Version/commit: v1.4.2 + validations: + required: false + + - type: textarea + id: logs + attributes: + label: Logs or screenshots + description: Add relevant logs, stack traces, screenshots, or other evidence. + render: shell + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional context + description: Add anything else that may help us understand the issue. + validations: + required: false + + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I searched existing issues and did not find a duplicate. + required: true + - label: I have provided enough information to reproduce the issue. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/chore.yml b/.github/ISSUE_TEMPLATE/chore.yml new file mode 100644 index 0000000..755bbc4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/chore.yml @@ -0,0 +1,78 @@ +name: Chore +description: Track maintenance, cleanup, refactoring, or internal work. +title: "chore: " +labels: + - chore +body: + - type: dropdown + id: type + attributes: + label: Chore type + options: + - Refactoring + - Documentation + - Dependencies + - CI/CD + - Testing + - Developer tooling + - Code cleanup + - Repository maintenance + - Other + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Describe the maintenance work that needs to be completed. + placeholder: | + Update... + Remove... + Refactor... + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why should this work be done? + placeholder: | + This will reduce... + This is needed because... + validations: + required: true + + - type: textarea + id: tasks + attributes: + label: Tasks + description: Break the work into smaller tasks when possible. + placeholder: | + - [ ] Update ... + - [ ] Remove ... + - [ ] Add tests ... + - [ ] Update documentation ... + validations: + required: false + + - type: textarea + id: acceptance + attributes: + label: Completion criteria + description: What needs to be true before this chore can be closed? + placeholder: | + - CI passes + - Old implementation is removed + - Documentation is updated + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional context + description: Add links, implementation notes, or related issues. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..3a8c646 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,78 @@ +name: Feature request +description: Suggest a new feature or improvement. +title: "feat: " +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + Thanks for suggesting an improvement. + + - type: textarea + id: problem + attributes: + label: Problem + description: What problem or limitation does this feature address? + placeholder: | + Currently, users cannot... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed solution + description: Describe the behavior or feature you would like to see. + placeholder: | + Add support for... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Have you considered any alternative approaches or workarounds? + validations: + required: false + + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + description: What should be true for this feature to be considered complete? + placeholder: | + - Users can ... + - The system should ... + - Tests cover ... + validations: + required: false + + - type: dropdown + id: priority + attributes: + label: Suggested priority + description: How important is this feature? + options: + - Low + - Medium + - High + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional context + description: Add mockups, examples, links, or other context. + validations: + required: false + + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I searched existing issues and did not find an existing request for this feature. + required: true \ No newline at end of file diff --git a/.github/pull_request_template.yml b/.github/pull_request_template.yml new file mode 100644 index 0000000..c17986c --- /dev/null +++ b/.github/pull_request_template.yml @@ -0,0 +1,64 @@ +## Summary + + + +## Related issue + + + +Closes # + +## Changes + + + +- +- +- + +## Testing + + + +- [ ] Existing tests pass +- [ ] New tests were added where appropriate +- [ ] I manually tested the affected behavior + +### Test instructions + + + +1. +2. +3. + +## Screenshots + + + +## Checklist + +- [ ] My changes are focused on the scope of this PR +- [ ] I have reviewed my own changes +- [ ] I have added or updated tests where appropriate +- [ ] I have updated documentation where appropriate +- [ ] There are no unnecessary debugging statements or commented-out code +- [ ] CI checks pass \ No newline at end of file