diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..48ff5b0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve +labels: bug + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment** +Include all relevant environment information: +1. OS [e.g. Ubuntu 20.04]: +2. Python version [e.g. 3.12.2]: + +**To Reproduce** +Exact steps to reproduce the behavior: + + +**Errors** +If applicable, add a full print-out of any errors or exceptions that are raised or include screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. Also include any relevant files. diff --git a/.github/ISSUE_TEMPLATE/doc-edit.md b/.github/ISSUE_TEMPLATE/doc-edit.md new file mode 100644 index 00000000..374a1a83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc-edit.md @@ -0,0 +1,18 @@ +--- +name: Doc edit +about: Propose changes to project documentation +labels: documentation + +--- + +**What is the URL, file, or UI containing proposed doc change** +Where does one find the original content or where would this change go? + +**What is the current content or situation in question** +Copy/paste the source content or describe gap. + +**What is the proposed change** +Add new content. + +**Additional context** +Add any other context about the change here. Also include any relevant files or URLs. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..93903107 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea for this project +labels: enhancement + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..5bc808cb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,38 @@ +## Summary + + + +## Details + + +- [ ] + +## Test Plan + + +- + +## Related Issues + + +- Resolves # + +--- + +- [ ] "I certify that all code in this PR is my own, except as noted below." + +## Use of AI + +- [ ] Includes AI-assisted code completion +- [ ] Includes code generated by an AI application +- [ ] Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes `## WRITTEN BY AI ##`)