chore(github): add docs and maintenance issue templates#2467
chore(github): add docs and maintenance issue templates#2467fallenbagel merged 2 commits intodevelopfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 📝 WalkthroughWalkthroughTwo new GitHub issue templates were added ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Pull request overview
This PR enhances the GitHub issue templates by adding two new templates for documentation and maintenance tasks, and adding a type field to all issue templates for better categorization and triage.
Changes:
- Added documentation issue template (
.github/ISSUE_TEMPLATE/documentation.yml) for reporting docs problems or improvements - Added maintenance/chore issue template (
.github/ISSUE_TEMPLATE/maintenance.yml) for internal tasks like CI, dependencies, and refactors - Added
typefield to bug and enhancement templates for improved issue categorization
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/maintenance.yml |
New template for maintenance/chore issues with dropdowns for area selection and fields for summary, acceptance criteria, and related links |
.github/ISSUE_TEMPLATE/documentation.yml |
New template for documentation issues with fields for page location, docs area, problem description, and suggested changes |
.github/ISSUE_TEMPLATE/enhancement.yml |
Added type: feature field for issue categorization |
.github/ISSUE_TEMPLATE/bug.yml |
Added type: bug field for issue categorization |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
🧹 Nitpick comments (2)
.github/ISSUE_TEMPLATE/maintenance.yml (1)
1-54: Consider adding "Search Existing Issues" and "Code of Conduct" checkboxes for consistency.The bug and enhancement templates both include:
- A "Search Existing Issues" checkbox (required)
- A "Code of Conduct" checkbox (required)
While this template targets maintainers/contributors, adding these checkboxes would maintain consistency across all issue templates and ensure contributors acknowledge the Code of Conduct.
♻️ Suggested addition at the end of the body
- type: input id: related attributes: label: Related links description: PRs, failing workflow runs, logs, or relevant issues. validations: required: false + + - type: checkboxes + id: search-existing + attributes: + label: Search Existing Issues + description: Have you searched existing issues to see if this task has already been tracked? + options: + - label: Yes, I have searched existing issues. + required: true + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/seerr-team/seerr/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow Seerr's Code of Conduct + required: true.github/ISSUE_TEMPLATE/documentation.yml (1)
63-70: Add hyperlink to the Code of Conduct for consistency.The bug and enhancement templates link to the Code of Conduct document in the description, but this template only mentions it by name. Adding the link would maintain consistency and help users easily access the document.
♻️ Suggested fix
- type: checkboxes id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our Code of Conduct. + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/seerr-team/seerr/blob/develop/CODE_OF_CONDUCT.md) options: - label: I agree to follow Seerr's Code of Conduct required: true
6c3607b to
d7f273b
Compare
Description
Add Documentation and Maintenance/Chore issue forms for better triage and non-feature work tracking. Issue type has also been added.
How Has This Been Tested?
Screenshots / Logs (if applicable)
Checklist:
pnpm buildpnpm i18n:extractSummary by CodeRabbit