Skip to content

chore(github): add docs and maintenance issue templates#2467

Merged
fallenbagel merged 2 commits intodevelopfrom
fallenbagel/chore/issue-templates-docs-maintenance
Feb 17, 2026
Merged

chore(github): add docs and maintenance issue templates#2467
fallenbagel merged 2 commits intodevelopfrom
fallenbagel/chore/issue-templates-docs-maintenance

Conversation

@fallenbagel
Copy link
Collaborator

@fallenbagel fallenbagel commented Feb 16, 2026

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:

  • I have read and followed the contribution guidelines.
  • Disclosed any use of AI (see our policy)
  • I have updated the documentation accordingly.
  • All new and existing tests passed.
  • Successful build pnpm build
  • Translation keys pnpm i18n:extract
  • Database migration (if required)

Summary by CodeRabbit

  • Chores
    • Updated issue templates: standardized labels and added explicit type fields for bug and enhancement reports.
    • Added new templates for documentation and maintenance tasks with structured form fields, validation, required checks, and guidance to capture location, area, problem, suggested fixes, and related links.

@coderabbitai
Copy link

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

Two new GitHub issue templates were added (documentation.yml, maintenance.yml), and existing templates (bug.yml, enhancement.yml) received top-level type fields and label adjustments.

Changes

Cohort / File(s) Summary
Updated Issue Templates
.github/ISSUE_TEMPLATE/bug.yml, .github/ISSUE_TEMPLATE/enhancement.yml
Added top-level type fields (type: bug in bug.yml, type: feature in enhancement.yml) and adjusted labels to only include awaiting triage (removed previous combined labels). No other body changes.
New Issue Templates
.github/ISSUE_TEMPLATE/documentation.yml, .github/ISSUE_TEMPLATE/maintenance.yml
Added two complete issue templates. documentation.yml introduces structured form fields (doc-location, doc-area dropdown, problem, suggested-fix, search-existing checkbox, terms checkbox) with labels, descriptions, placeholders, and validations. maintenance.yml defines area dropdown, summary, acceptance criteria, related links, plus required search and code-of-conduct checks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hop in to tidy every issue line,
Adding types and templates so reports align.
Docs and chores now have their proper place,
Bugs and features wear a clearer face.
Hop — the tracker’s neat, one hop at a time.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: adding documentation and maintenance issue templates to the GitHub configuration, which aligns with the file modifications across bug.yml, documentation.yml, enhancement.yml, and maintenance.yml.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 type field 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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:

  1. A "Search Existing Issues" checkbox (required)
  2. 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

@fallenbagel fallenbagel force-pushed the fallenbagel/chore/issue-templates-docs-maintenance branch from 6c3607b to d7f273b Compare February 16, 2026 19:22
@fallenbagel fallenbagel enabled auto-merge (squash) February 16, 2026 19:23
@fallenbagel fallenbagel merged commit cf4883a into develop Feb 17, 2026
11 checks passed
@fallenbagel fallenbagel deleted the fallenbagel/chore/issue-templates-docs-maintenance branch February 17, 2026 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments