Skip to content

Commit

Permalink
Adding issue and PR templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdlaird committed Feb 24, 2024
1 parent 773030b commit 5b26119
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: 🐛 Bug Report
description: Found a bug? Help us squash it.
labels: ["bug"]

body:

- type: checkboxes
id: ack
attributes:
label: Acknowledgements
options:
- label: I have written a descriptive issue title
required: true
- label: I have searched [Issues](issues?q=is%3Aissue) to see if the bug has already been reported
required: true
- label: I have searched [Stack Overflow](https://stackoverflow.com/questions/) to ensure the issue I'm experiencing has not already been discussed

- type: input
id: os-version
attributes:
label: Operating System
placeholder: macOS 10.14.5
validations:
required: true

- type: input
id: python-version
attributes:
label: Python Version
placeholder: 3.9.2
validations:
required: true

- type: textarea
id: describe-the-bug
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is, including exceptions thrown.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: A snippet of the code used to reproduce the behavior.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: A brief description of what you expected to happen.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: 🚀 Feature Request
description: Want something? Let us know.
labels: ["enhancement"]

body:

- type: checkboxes
id: ack
attributes:
label: Acknowledgements
options:
- label: I have written a descriptive issue title
required: true
- label: I have searched [Issues](issues?q=is%3Aissue) to see if the feature has already been requested

- type: textarea
id: describe-the-feature
attributes:
label: Describe the Feature
description: A clear and concise description of the how and why of the feature you'd like to see. If possible, include possible code snippets of interfaces you'd like to see and how you might interact with them.
validations:
required: true

- type: textarea
id: describe-workarounds
attributes:
label: Describe Alternative Solutions/Workarounds
description: A clear and concise description of any alternative solutions or features you've considered. If applicable, please provide snippets of any current workarounds you use.
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
**Description**
A clear and concise description of what was changed.

**Issues**
A list of GitHub issues related to this PR.

**Type of Change**
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a schema change
- [ ] This change requires a documentation update

**Testing Done**
A clear and concise description of the new tests added to validate the change as well as any manual testing done.

**Checklist**
- [ ] I have added tests that prove my change works as expected, and `make test` passes with no new errors or warnings
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code in particularly hard-to-understand areas
11 changes: 11 additions & 0 deletions .github/label-commenter-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
labels:
- name: invalid-forum
labeled:
issue:
body: |
This is a bug tracker and not a support forum.
While we'd love to be able to support every person on their projects, that would simply be infeasible. Luckily, that's what the helpful developer community over at Stack Overflow is for! Please [create a question there](https://stackoverflow.com/questions/ask?tags=python) if what you're looking for is a programming question or you need help with an integration.
If you [support the project](https://github.com/sponsors/alexdlaird), contact me directly and I'd be happy to help you troubleshoot.
action: close
20 changes: 20 additions & 0 deletions .github/workflows/label-commenter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: "Label Commenter"

on:
issues:
types:
- labeled

jobs:
comment:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: main

- name: Label Commenter
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
config_file: .github/label-commenter-config.yml

0 comments on commit 5b26119

Please sign in to comment.