Skip to content

Commit

Permalink
Merge pull request #123 from nrkno/chore/update-github-templates
Browse files Browse the repository at this point in the history
chore/Add GitHub templates that work
  • Loading branch information
nytamin authored Dec 14, 2023
2 parents a8c077b + 956d615 commit e22008e
Show file tree
Hide file tree
Showing 6 changed files with 208 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Bug Report 🐛
description: Use this if you've found a bug
title: "Bug Report: [Short description of the bug]"
labels:
- 🐛bug

body:
- type: markdown
attributes:
value: |
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
- type: textarea
attributes:
label: About me
description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
placeholder: Example "This RFC is posted on behalf of the NRK."
validations:
required: true

- type: textarea
attributes:
label: Observed Behavior
description: What happened?
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: true

- type: input
attributes:
label: Version
description: What version of Sofie Core / Gateways / other components are you using?
validations:
required: true

- type: textarea
attributes:
label: Severity / Impact
description: How big of an issue is this? How does this limit your operations?
placeholder: |
Examples:
* This is a blocker for us, we cannot use feature X until this is fixed.
* Not a big issue for us, but it would be nice to have this fixed.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Other Issue 🔧
description: Use this for other issues
title: "Other: [Short description of the issue]"
labels:
- Other

body:
- type: markdown
attributes:
value: |
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
- type: textarea
attributes:
label: About me
description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
placeholder: Example "This RFC is posted on behalf of the NRK."
validations:
required: true

- type: textarea
attributes:
label: Issue
description: Describe the issue below
validations:
required: true
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Question ❓
description: Use this if you have a question to the Sofie team
title: "Question: [Short summary of the question]"
labels:
- ❓ Question

body:
- type: markdown
attributes:
value: |
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
- type: textarea
attributes:
label: About me
description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
placeholder: Example "This RFC is posted on behalf of the NRK."
validations:
required: true

- type: textarea
attributes:
label: My Question
description: Write your question below
validations:
required: true
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Request for Comments ❗
description: Use this to initiate a discussion about a new feature or a larger change
title: "RFC: [Short description of the feature/change]"
labels:
- RFC
- Contribution

body:
- type: markdown
attributes:
value: |
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
- type: textarea
attributes:
label: About me
description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
placeholder: Example "This RFC is posted on behalf of the NRK."
validations:
required: true

- type: textarea
attributes:
label: Use case
description: "Please write some background information here, such as: What is your use case? What problem are you trying to solve?"
validations:
required: true

- type: textarea
attributes:
label: Proposal
description: Please describe your proposal here
validations:
required: true

- type: textarea
attributes:
label: Process
description: Please don't touch this section, the Sofie team will update this as the RFC progresses.
value: |
The Sofie Team will evaluate this RFC and open up a discussion about it, usually within a week.
- [x] RFC created
- [ ] Sofie Team has evaluated the RFC
- [ ] A workshop has been planned
- [ ] RFC has been discussed in a workshop
- [ ] A conclusion has been reached, see comments in thread
56 changes: 56 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!--
Before you open a PR, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
-->

## About the Contributor
<!--
Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
Example: "This pull request is posted on behalf of the NRK."
-->


## Type of Contribution

This is a:
<!-- (pick one) -->
Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify)


## Current Behavior
<!--
Please describe how things worked before this PR.
If it's a bug fixe: Describe the bug (what was happening?)
-->


## New Behavior
<!--
What is the new behavior?
-->


## Testing Instructions
<!--
Please provide some instructions and other information for how to verify that the feature works.
Examples:
* "Do a Take for a part that contains an adlib, verify that the adlib plays out."
* "Open the Switchboard panel and toggle a route, verify that the route toggles in the GUI."
* "This feature also affects 'feature X', so that needs to be tested for regressions as well."
-->


## Other Information
<!-- The more information you can provide, the easier the pull request will be to merge -->


## Status
<!--
Before you open the PR, make sure the items below are done.
If they're not, please open the PR as a Draft.
-->

- [ ] PR is ready to be reviewed.
- [ ] The functionality has been tested by the author.
- [ ] Relevant unit tests has been added / updated.
- [ ] Relevant documentation (code comments, [system documentation](https://nrkno.github.io/sofie-core/)) has been added / updated.

0 comments on commit e22008e

Please sign in to comment.