From cce0c921b551254d7671f731e1bdd290e04e60cc Mon Sep 17 00:00:00 2001 From: Samuel Monson Date: Thu, 31 Jul 2025 11:28:45 -0400 Subject: [PATCH 1/3] Add issue templates based on llm-compressor Signed-off-by: Samuel Monson --- .github/ISSUE_TEMPLATE/bug_report.md | 27 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/doc-edit.md | 18 +++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 +++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/doc-edit.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md 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. From aebe1fb6e29ce0628a9c3f33a4f36c2e2a4366b0 Mon Sep 17 00:00:00 2001 From: Samuel Monson Date: Thu, 31 Jul 2025 11:29:04 -0400 Subject: [PATCH 2/3] Add a pull request template Signed-off-by: Samuel Monson --- .github/PULL_REQUEST_TEMPLATE.md | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..81aaab51 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,40 @@ +## 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 ##` From ffc2649893661ba3951bbcc83d7ab89e5fe5762b Mon Sep 17 00:00:00 2001 From: Samuel Monson Date: Mon, 4 Aug 2025 15:35:28 -0400 Subject: [PATCH 3/3] PR text does not support [!NOTE] Signed-off-by: Samuel Monson --- .github/PULL_REQUEST_TEMPLATE.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 81aaab51..5bc808cb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -35,6 +35,4 @@ Link any relevant issues that this PR addresses. - [ ] 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 ##` +- [ ] Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes `## WRITTEN BY AI ##`)