Skip to content

Commit

Permalink
#336 Add GitHub Templates (#338)
Browse files Browse the repository at this point in the history
  • Loading branch information
tariqksoliman authored Feb 22, 2023
1 parent 3d33ea0 commit dc4d7ff
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug Report Form
description: Report a bug to help us improve
title: "[Bug]: "
labels: "bug"
body:
- type: markdown
attributes:
value: |
> _Thanks for filing a bug ticket. We appreciate your time and effort. Please answer a few questions._
- type: dropdown
id: checked-for-duplicates
attributes:
label: Checked for duplicates
description: Have you checked for duplicate issue tickets?
multiple: false
options:
- "Yes - I've already checked"
- "No - I haven't checked"
validations:
required: yes
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. Plain-text snippets preferred but screenshots welcome.
placeholder: Tell us what you saw
value: "When I did [...] action, I noticed [...]"
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: What did you expect?
description: A clear and concise description of what you expect to happen
placeholder: Tell us what you expected
value: "I expected [...]"
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproducible steps
description: "How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets preferred but screenshots welcome."
value: |
1.
2.
3.
...
render: bash
- type: textarea
id: environment
attributes:
label: Environment
description: "What is your environment? Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue"
value: |
- Version of this software [e.g. vX.Y.Z]
- Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
...
render: bash
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: New Feature Form
description: Suggest a new feature for us to implement
title: "[New Feature]: "
labels: "enhancement"
body:
- type: markdown
attributes:
value: |
> _Thanks for filing a new feature request. We appreciate your time and effort. Please answer a few questions._
- type: dropdown
id: checked-for-duplicates
attributes:
label: Checked for duplicates
description: Have you checked for duplicate issue tickets?
multiple: false
options:
- "Yes - I've already checked"
- "No - I haven't checked"
validations:
required: yes
- type: dropdown
id: checked-alternatives
attributes:
label: Alternatives considered
description: Have you considered alternative solutions to your feature request?
options:
- "Yes - and alternatives don't suffice"
- "No - I haven't considered"
validations:
required: yes
- type: textarea
id: related-problems
attributes:
label: Related problems
description: Is your feature request related to any problems? Please help us understand if so, including linking to any other issue tickets.
placeholder: Tell us the problems
value: "I'm frustrated when [...] happens as documented in issue-XYZ"
validations:
required: false
- type: textarea
id: description
attributes:
label: Describe the feature request
description: A clear and concise description of your request.
placeholder: Tell us what you want
value: "I need or want [...]"
validations:
required: true
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Purpose
- Clear, easy-to-understand sentences outlining the purpose of the PR
## Proposed Changes
- [ADD] ...
- [CHANGE] ...
- [FIX] ...
## Issues
- Links to relevant issues
- Example: issue-XYZ
## Testing
- Provide some proof you've tested your changes
- Example: test results available at ...
- Example: tested on operating system ...

0 comments on commit dc4d7ff

Please sign in to comment.