Skip to content

Commit a2b399b

Browse files
committed
docs(github): enhance pull request template with detailed guidelines and checklist
Signed-off-by: Yurii Serhiichuk <[email protected]>
1 parent b367825 commit a2b399b

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

.github/pull_request_template.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
1-
Fixes #<issuelink>
1+
<!--
2+
Thank you for contributing to the project!
23
3-
## Changes
4+
Please make sure to read the `CONTRIBUTING.md` file for our contribution guidelines:
5+
https://github.com/cloudevents/sdk-python/blob/main/CONTRIBUTING.md
6+
-->
47

8+
<!--
9+
Please provide a clear and concise description of the pull request.
10+
-->
511

6-
## One line description for the changelog
12+
**Related Issue:** #<issue_number>
713

14+
**Type of change:**
15+
<!--
16+
Please select one of the following options and delete the others.
17+
-->
18+
- Bug fix (non-breaking change which fixes an issue)
19+
- New feature (non-breaking change which adds functionality)
20+
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
21+
- This change requires a documentation update
22+
- Other (please describe):
823

9-
- [ ] Tests pass
10-
- [ ] Appropriate changes to README are included in PR
24+
**Description:**
25+
<!--
26+
Please include a summary of the change and which issue is fixed.
27+
Please also include relevant motivation and context.
28+
List any dependencies that are required for this change.
29+
-->
30+
31+
---
32+
33+
**Pre-submission checklist:**
34+
- [ ] I have read the [CONTRIBUTING.md](https://github.com/cloudevents/sdk-python/blob/main/CONTRIBUTING.md) file.
35+
- [ ] I have signed off my commits using `git commit --signoff`.
36+
- [ ] I have added tests that prove my fix is effective or that my feature works.
37+
- [ ] I have updated the documentation (`README.md`, `CHANGELOG.md`, etc.) as necessary.
38+
- [ ] I have run `pre-commit` and `tox` and all checks pass.
39+
- [ ] This pull request is ready to be reviewed.

0 commit comments

Comments
 (0)