From edbb78e2773a0d403f4f59f671272a63539e2896 Mon Sep 17 00:00:00 2001 From: Dhananjhay Date: Wed, 18 Jun 2025 09:54:35 -0400 Subject: [PATCH] add templates for issues and PRs --- .github/ISSUE_TEMPLATE.md | 8 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 26 ++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..a7df7ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,8 @@ +## The problem + +Briefly describe the issue you are experiencing (or feature you want to see added). Tell us what you were trying to do and what happened instead. If you have any helpful screenshots or a file you tried to upload, please include them! Please also select an appropriate label (to the right). + +## Environment + +- Operating System +- Autoafids version diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..dfc4577 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +## Proposed changes + +Describe the changes implemented in this pull request. If the changes fix a bug or resolves a feature request, be sure to link the issue. Please explain the issue and how the changes address the issue. + +## Types of changes + +What types of changes does your code introduce? Put an `x` in the boxes that apply + +- [ ] Bugfix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionalitiy) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Other (if none of the other choices apply) + +## Checklist + +Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask! + +- [ ] Changes have been tested to ensure that fix is effective or that a feature works. +- [ ] Changes pass the unit tests +- [ ] Changes pass the wet run tests +- [ ] Code has been run through the `poe quality` task +- [ ] I have included necessary documentation or comments (as necessary) +- [ ] Any dependent changes have been merged and published + +## Notes +All PRs will undergo unit and wet run testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.