Skip to content

Commit 304a54a

Browse files
authored
Add PR and Issue templates (#252)
## Summary <!-- Include a short paragraph of the changes introduced in this PR. If this PR requires additional context or rationale, explain why the changes are necessary. --> This PR adds templates for issues and pull requests. This helps maintainers by encouraging users/contributors to provide all necessary information. ## Details <!-- Provide a detailed list of all changes introduced in this pull request. --> - [x] Add issue templates from [llm-compressor](https://github.com/vllm-project/llm-compressor) - [x] Add a PR template ## Test Plan <!-- List the steps needed to test this PR. --> - Open a PR or issue using the given templates --- - [x] "I certify that all code in this PR is my own, except as noted below." ## Use of AI - [ ] Includes AI-assisted code completion - [x] Includes code generated by an AI application - [ ] Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes `## WRITTEN BY AI ##`) ## External Sources - [x] Other compatible open source projects --------- Signed-off-by: Samuel Monson <[email protected]>
1 parent 71f1e3c commit 304a54a

File tree

4 files changed

+101
-0
lines changed

4 files changed

+101
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
6+
---
7+
8+
**Describe the bug**
9+
A clear and concise description of what the bug is.
10+
11+
**Expected behavior**
12+
A clear and concise description of what you expected to happen.
13+
14+
**Environment**
15+
Include all relevant environment information:
16+
1. OS [e.g. Ubuntu 20.04]:
17+
2. Python version [e.g. 3.12.2]:
18+
19+
**To Reproduce**
20+
Exact steps to reproduce the behavior:
21+
22+
23+
**Errors**
24+
If applicable, add a full print-out of any errors or exceptions that are raised or include screenshots to help explain your problem.
25+
26+
**Additional context**
27+
Add any other context about the problem here. Also include any relevant files.

.github/ISSUE_TEMPLATE/doc-edit.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Doc edit
3+
about: Propose changes to project documentation
4+
labels: documentation
5+
6+
---
7+
8+
**What is the URL, file, or UI containing proposed doc change**
9+
Where does one find the original content or where would this change go?
10+
11+
**What is the current content or situation in question**
12+
Copy/paste the source content or describe gap.
13+
14+
**What is the proposed change**
15+
Add new content.
16+
17+
**Additional context**
18+
Add any other context about the change here. Also include any relevant files or URLs.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
6+
---
7+
8+
**Is your feature request related to a problem? Please describe.**
9+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
11+
**Describe the solution you'd like**
12+
A clear and concise description of what you want to happen.
13+
14+
**Describe alternatives you've considered**
15+
A clear and concise description of any alternative solutions or features you've considered.
16+
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Summary
2+
3+
<!--
4+
Include a short paragraph of the changes introduced in this PR.
5+
If this PR requires additional context or rationale, explain why
6+
the changes are necessary.
7+
-->
8+
9+
## Details
10+
11+
<!--
12+
Provide a detailed list of all changes introduced in this pull request.
13+
-->
14+
- [ ]
15+
16+
## Test Plan
17+
18+
<!--
19+
List the steps needed to test this PR.
20+
-->
21+
-
22+
23+
## Related Issues
24+
25+
<!--
26+
Link any relevant issues that this PR addresses.
27+
-->
28+
- Resolves #
29+
30+
---
31+
32+
- [ ] "I certify that all code in this PR is my own, except as noted below."
33+
34+
## Use of AI
35+
36+
- [ ] Includes AI-assisted code completion
37+
- [ ] Includes code generated by an AI application
38+
- [ ] Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes `## WRITTEN BY AI ##`)

0 commit comments

Comments
 (0)