Skip to content

Commit 4c52ec6

Browse files
chore(templates): update PR template
1 parent 7f2dd6b commit 4c52ec6

1 file changed

Lines changed: 39 additions & 10 deletions

File tree

.github/pull_request_template.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<!---
2+
NOTE: DO NOT DELETE ANY COMMENTS OR SECTIONS OF THIS TEMPLATE.
3+
THEY ARE IMPORTANT FOR THE MAINTAINERS.
4+
IT IS OKAY TO LEAVE SECTIONS EMPTY AND BOXES UNCHECKED IF THEY DO NOT APPLY TO YOUR PR.
5+
--->
6+
17
## Description
28
<!--- Please include a summary of the changes. --->
39

@@ -7,21 +13,44 @@
713

814

915
### Issues Fixed or Closed
16+
<!--- If this PR fixes or closes any issues, please list them here. --->
1017
<!--- Close issue example: `- Closes #1` --->
1118
<!--- Fix bug issue example: `- Fixes #2` --->
1219
<!--- Resolve issue example: `- Resolves #3` --->
1320

1421

22+
#### Roadmap Issues
23+
<!--- If this PR solves any roadmap issues (https://github.com/LizardByte/roadmap/issues), please list them here. --->
24+
<!--- e.g. `- Closes https://github.com/LizardByte/roadmap/issues/1` --->
25+
26+
1527
## Type of Change
16-
- [ ] Bug fix (non-breaking change which fixes an issue)
17-
- [ ] New feature (non-breaking change which adds functionality)
18-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
19-
- [ ] Dependency update (updates to dependencies)
20-
- [ ] Documentation update (changes to documentation)
21-
- [ ] Repository update (changes to repository files, e.g. `.github/...`)
28+
<!--- Select the type of change your PR introduces. You can select multiple types. --->
29+
- [ ] **feat**: New feature (non-breaking change which adds functionality)
30+
- [ ] **fix**: Bug fix (non-breaking change which fixes an issue)
31+
- [ ] **docs**: Documentation only changes
32+
- [ ] **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
33+
- [ ] **refactor**: Code change that neither fixes a bug nor adds a feature
34+
- [ ] **perf**: Code change that improves performance
35+
- [ ] **test**: Adding missing tests or correcting existing tests
36+
- [ ] **build**: Changes that affect the build system or external dependencies
37+
- [ ] **ci**: Changes to CI configuration files and scripts
38+
- [ ] **chore**: Other changes that don't modify src or test files
39+
- [ ] **revert**: Reverts a previous commit
40+
- [ ] **BREAKING CHANGE**: Introduces a breaking change (can be combined with any type above)
41+
2242

2343
## Checklist
24-
- [ ] My code follows the style guidelines of this project
25-
- [ ] I have performed a self-review of my own code
26-
- [ ] I have commented my code, particularly in hard-to-understand areas
27-
- [ ] I have added or updated the in code docstring/documentation-blocks for new or existing methods/components
44+
<!--- Please check all applicable boxes. If a box does not apply, leave it unchecked. --->
45+
- [ ] Code follows the style guidelines of this project
46+
- [ ] Code has been self-reviewed
47+
- [ ] Code has been commented, particularly in hard-to-understand areas
48+
- [ ] Code docstring/documentation-blocks for new or existing methods/components have been added or updated
49+
- [ ] Unit tests have been added or updated for any new or modified functionality
50+
51+
### AI Usage
52+
<!--- Select the option that best describes AI usage in this PR (choose only one). --->
53+
- [ ] **None**: No AI tools were used in creating this PR
54+
- [ ] **Light**: AI provided minor assistance (formatting, simple suggestions)
55+
- [ ] **Moderate**: AI helped with code generation or debugging specific parts
56+
- [ ] **Heavy**: AI generated most or all of the code changes

0 commit comments

Comments
 (0)