[ISSUE 31] Create Issue Templates #37
There are no files selected for viewing
This file contains 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,49 @@ | ||
| name: ADR | ||
| description: Record an architectural decision about the project | ||
| title: "[ADR]: " | ||
| labels: ["docs: adr"] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Record an architectural decision about the project | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| **Example** [Wiki ADR](https://github.com/HHS/grants-api/issues/30) | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: 1-2 sentence summary of the decision that needs to be made | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: options | ||
| attributes: | ||
| label: Options | ||
| description: List of options to evaluate | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: decision-criteria | ||
| attributes: | ||
| label: Decision Criteria | ||
| description: List of decision criteria to evaluate | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| id: definition-of-done | ||
| attributes: | ||
| label: Definition of Done | ||
| description: Leave the following acceptance criteria unchecked when the ticket is created then mark them as completed as you meet each criterion with the ADR | ||
| options: | ||
| - label: The ADR is drafted and stored in `documentation/decisions/adr` | ||
| - label: The ADR is included in the necessary table of contents in the ADR/decision folder | ||
| - label: The ADR describes the drivers and pros and cons of the decision | ||
| - label: The ADR has been reviewed and approved by the internal team | ||
| - label: The ADR satisfies requirements that are outlined in the ADR template | ||
| validations: | ||
| required: true |
This file contains 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,64 @@ | ||
| name: Bug Report | ||
| description: File a bug report | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| - type: input | ||
| id: contact | ||
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you if we need more info? | ||
| placeholder: ex. [email protected] | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened? | ||
| description: Also tell us, what did you expect to happen? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-repro | ||
| attributes: | ||
| label: Steps to reproduce the behavior | ||
| description: How can we verify the bug ourselves? | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: priority | ||
| attributes: | ||
| label: Priority | ||
| description: Suggested bug priority | ||
| options: | ||
| - low (inconvenience) | ||
| - medium (please fix soon) | ||
| - high (this is breaking and/or blocking) | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
| render: shell | ||
| - type: textarea | ||
| id: screenshots-and-context | ||
| attributes: | ||
| label: Screenshots and additional context | ||
| description: Please upload any relevant screenshots. | ||
| # TODO: Uncomment after adding Code of Conduct | ||
| # - type: checkboxes | ||
| # id: terms | ||
| # attributes: | ||
| # label: Code of Conduct | ||
| # description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) | ||
| # options: | ||
| # - label: I agree to follow this project's Code of Conduct | ||
| # required: true |
This file contains 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,52 @@ | ||
| name: Feature Request | ||
| description: File a feature request | ||
| title: "[Feature Request]: " | ||
| labels: ["enhancement"] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out a feature request! | ||
| - type: input | ||
| id: contact | ||
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you if we need more info? | ||
| placeholder: ex. [email protected] | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: describe-problem | ||
| attributes: | ||
| label: Is your feature request related to a problem? Please describe | ||
| description: A clear and concise description of what the problem is. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: describe-solution | ||
| attributes: | ||
| label: A clear and concise description of what you want to happen | ||
| description: Help us understand your improvement ideas. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Describe alternatives you've considered | ||
| description: A clear and concise description of any alternative solutions or features you've considered. | ||
| - type: textarea | ||
| id: screenshots-and-context | ||
| attributes: | ||
| label: Screenshots and additional context | ||
| description: Please upload any relevant screenshots. | ||
| # TODO: Uncomment after adding Code of Conduct | ||
| # - type: checkboxes | ||
| # id: terms | ||
| # attributes: | ||
| # label: Code of Conduct | ||
| # description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) | ||
| # options: | ||
| # - label: I agree to follow this project's Code of Conduct | ||
| # required: true |
This file contains 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,33 @@ | ||
| name: Milestone | ||
| description: Draft a new milestone document | ||
| title: "[Milestone]: " | ||
| labels: ["docs: milestone"] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Draft a new milestone document | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| **Example:** [DB & API Planning](https://github.com/HHS/grants-api/issues/21) | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: 1-2 sentence summary with link to short description | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: definition-of-done | ||
| attributes: | ||
| label: Definition of Done | ||
| description: Leave the following acceptance criteria unchecked when the ticket is created then mark them as completed as you meet each criterion with the milestone document | ||
| options: | ||
| - label: Milestone document is updated and stored in `documents/milestones/individual_milestones/` | ||
| - label: The milestone document has been linked under the appropriate section in the short description doc | ||
| - label: The milestone has node has been updated to "planning" in the dependency diagram | ||
| - label: Milestone has been reviewed and approved by the internal team | ||
| - label: A corresponding epic has been created for the milestone |
This file contains 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,39 @@ | ||
| name: Story (Internal Use Only) | ||
| description: Tracking our work through stories | ||
| title: "[Story]: " | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: textarea | ||
| id: summary | ||
| attributes: | ||
| label: Summary | ||
| description: A clear and concise summary of the task | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: user-story | ||
| attributes: | ||
| label: User story | ||
| description: A clear and concise description from the perspective of the user. | ||
| placeholder: Tell us about it from the user's perspective! | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: acceptance-criteria | ||
| attributes: | ||
| label: Acceptance criteria | ||
| description: A clear and concise checklist of expectations including definition of done. | ||
| placeholder: Explain the steps to success! | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: testing | ||
| attributes: | ||
| label: Describe the proposed testing strategy | ||
| description: A clear and concise description of what testing is required. | ||
| - type: textarea | ||
| id: screenshots-and-context | ||
| attributes: | ||
| label: Screenshots and additional context | ||
| description: Please upload any relevant screenshots and include additional context. |
This file contains 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: Task (Internal Use Only) | ||
| description: Tracking our work through tasks | ||
| title: "[Task]: " | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: textarea | ||
| id: summary | ||
| attributes: | ||
| label: Summary | ||
| description: A clear and concise summary of the task | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: acceptance-criteria | ||
| attributes: | ||
| label: Acceptance criteria | ||
| description: A clear and concise checklist of expectations including definition of done. | ||
| placeholder: Explain the steps to success! | ||
| validations: | ||
| required: false |
This file contains 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,14 @@ | ||
| ## Summary | ||
| Fixes #{ISSUE} | ||
|
|
||
| ### Time to review: __x mins__ | ||
|
|
||
| ## Changes proposed | ||
| > What was added, updated, or removed in this PR. | ||
|
|
||
| ## Context for reviewers | ||
| > Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified. | ||
|
There was a problem hiding this comment. Cool this feels much more flexible than "Instructions to review", great addition |
||
|
|
||
| ## Additional information | ||
| > Screenshots, GIF demos, code examples or output to help show the changes working as expected. | ||
|
|
||
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.
Ooh love this!!