Skip to content

Commit

Permalink
Add pull request & issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
cerus committed Jun 11, 2022
1 parent fda5340 commit 6184f4e
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "Bug report"
description: "Template for bug reports"
labels: [ bug ]
body:
- type: textarea
attributes:
label: "Issue description"
description: "Please describe the issue you're experiencing as detailed as possible."
validations:
required: true
- type: textarea
attributes:
label: "To reproduce"
description: "How can the bug be reproduced?"
validations:
required: true
- type: textarea
attributes:
label: "Expected behaviour"
description: "What did you expect to happen?"
validations:
required: true
- type: textarea
attributes:
label: "Screenshots / videos"
description: "Link screenshots and videos here if you have any"
validations:
required: false
- type: input
attributes:
label: "MCHR version"
description: "MCHR version"
validations:
required: true
- type: textarea
attributes:
label: "Additional information"
description: "Anything else you want to share?"
validations:
required: false
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/contribution-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: "Contribution request"
description: "Template for contribution requests"
labels: [ enhancement ]
body:
- type: dropdown
attributes:
label: "Type"
options: [ "New feature", "Bugfix", "Documentation", "Other" ]
validations:
required: true
- type: input
attributes:
label: "If you chose 'other': Specify the contribution type"
validations:
required: false
- type: textarea
attributes:
label: "Changes"
description: "Please describe what you would like to change. Be as precise as possible."
validations:
required: true
- type: textarea
attributes:
label: "Relevant issues"
description: "Please link any relevant issues here."
validations:
required: false
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: "Feature request"
description: "Template for feature requests"
labels: [ enhancement ]
body:
- type: textarea
attributes:
label: "Feature description"
description: "Please describe the feature you want added in as much detail as possible."
validations:
required: true
- type: textarea
attributes:
label: "Relevant issues"
description: "Please link any relevant issues here."
validations:
required: false
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Changes

*Please list your changes here. Be as precise as possible.*

## Reference issue

*Please reference the issue you created / claimed here.*

## Other issues

*If there are any other relevant issues, link them here. For example, if this is a bugfix and there is an issue that reports the bug you have fixed,
link the issue like this: 'Fixes #ISSUE'*

0 comments on commit 6184f4e

Please sign in to comment.