Skip to content

Commit a2790d3

Browse files
committed
docs(pull_request_template): make the checklist holistic
1 parent 617b610 commit a2790d3

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

.github/pull_request_template.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,24 @@ Please fill in the following content to let us know better about this change.
99

1010
## Checklist
1111

12+
- [ ] I have read the [contributing guidelines](https://commitizen-tools.github.io/commitizen/contributing/)
13+
14+
### Code Changes
15+
1216
- [ ] Add test cases to all the changes you introduce
13-
- [ ] Run `poetry all` locally to ensure this change passes linter check and test
14-
- [ ] Test the changes on the local machine manually
17+
- [ ] Run `poetry all` locally to ensure this change passes linter check and tests
18+
- [ ] Manually test the changes:
19+
- [ ] Verify the feature/bug fix works as expected in real-world scenarios
20+
- [ ] Test edge cases and error conditions
21+
- [ ] Ensure backward compatibility is maintained
22+
- [ ] Document any manual testing steps performed
1523
- [ ] Update the documentation for the changes
1624

17-
## Expected behavior
25+
### Documentation Changes
26+
27+
- [ ] Run `poetry doc` locally to ensure the documentation pages renders correctly
28+
29+
## Expected Behavior
1830
<!-- A clear and concise description of what you expected to happen -->
1931

2032

@@ -25,5 +37,5 @@ Please fill in the following content to let us know better about this change.
2537
3. ... -->
2638

2739

28-
## Additional context
40+
## Additional Context
2941
<!-- Add any other RELATED ISSUE, context or screenshots about the pull request here. -->

0 commit comments

Comments
 (0)