Skip to content

Commit

Permalink
Github issue and PR templates (#12)
Browse files Browse the repository at this point in the history
- Adding GitHub issue and PR templates for better review and approval
steps.
  • Loading branch information
wilwade authored Mar 29, 2024
1 parent f0e76cb commit f33d3dc
Show file tree
Hide file tree
Showing 5 changed files with 123 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
name: Bug Report
description: File a bug report
title: '[Bug]: '
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: 'A bug happened!'
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Mobile Chrome
- Mobile Safari
- Mobile Firefox
- 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
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/02-content-change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
name: Content Update
description: Content change request
title: '[Content]: '
body:
- type: markdown
attributes:
value: |
- Where is the content that will change?
- What is the new content?
- type: textarea
attributes:
label: Content Source
value: |
Who wrote the new content?
- type: textarea
attributes:
label: Approvals already received
value: |
Remember that changes along the way trigger re-approval.
- [ ] Approved HE (Required for technical wording)
- [ ] Approved CM
- [ ] Approved UO
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/03-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
name: New Feature
description: New feature, page, etc...
title: '[Feature]: '
body:
- type: markdown
attributes:
value: |
## Design link/screenshots
## Details
- type: textarea
attributes:
label: Content approvals already received
value: |
Remember that content changes requires approval.
- [ ] Approved HE (Required for technical wording)
- [ ] Approved CM
- [ ] Approved UO
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-config.json
blank_issues_enabled: true
38 changes: 38 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

- Closes # (issue)

## Screenshot(s)

Including screenshots helps reviewers know what to expect.

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Content Change (Required approval in Slack: `#frequency-xyz` and remember that changes along the way trigger
re-approval.)
- [ ] Approved HE (Required for technical wording)
- [ ] Approved CM
- [ ] Approved UO
- [ ] New Feature
- [ ] CI/Dependencies/etc...
- [ ] Other

# How to Test?

Please describe how to test that you ran to verify your changes. Provide instructions so we can reproduce. Please also
list any relevant details for your test configuration

1. Pull and run locally
2. Go to
3. See that

# Checklist:

- [ ] I have performed a self-review of my code
- [ ] I have commented my code & PR, particularly in hard-to-understand areas
- [ ] I have checked at all the breakpoints to make sure it works on all screen sizes

0 comments on commit f33d3dc

Please sign in to comment.