Skip to content

Commit 4de076d

Browse files
authored
Improve PR template (#7052)
1 parent 02cbac6 commit 4de076d

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
<!-- !! Thank your for opening a PR !! -->
22

3-
**What is this PR about?**
4-
...
3+
<!--- Provide a self-contained summary of your changes in the Title above -->
4+
<!--- This is what will be shown in the automatic release notes: https://github.com/pymc-devs/pymc/releases -->
55

6-
**Checklist**
7-
+ [ ] Explain important implementation details 👆
8-
+ [ ] Make sure that [the pre-commit linting/style checks pass](https://docs.pymc.io/en/latest/contributing/python_style.html).
9-
+ [ ] Link relevant issues (preferably in [nice commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html))
10-
+ [ ] Are the changes covered by tests and docstrings?
11-
+ [ ] Fill out the short summary sections 👇
6+
## Description
7+
<!--- Describe your changes in detail -->
128

13-
## Major / Breaking Changes
14-
- ...
9+
## Related Issue
10+
<!--- It is good practice to first open an issue explaining the bug / new feature that is addressed by this PR -->
11+
<!--- Please type an `x` in one of the boxes below and provide the issue number after the # sign: -->
12+
- [ ] Closes issue: #
13+
- [ ] Related issue (not closed by this PR): #
1514

16-
## New features
17-
- ...
15+
## Checklist
16+
<!--- Make sure you have completed the following steps before submitting your PR -->
17+
<!--- Feel free to type an `x` in all the boxes below to let us know you have completed the steps: -->
18+
- [ ] Checked that [the pre-commit linting/style checks pass](https://docs.pymc.io/en/latest/contributing/python_style.html)
19+
- [ ] Included tests that prove the fix is effective or that the new feature works
20+
- [ ] Added necessary documentation (docstrings and/or example notebooks)
21+
- [ ] If you are a pro: each commit corresponds to a [relevant logical change](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes)
22+
<!--- You may find this guide helpful: https://mainmatter.com/blog/2021/05/26/keeping-a-clean-git-history/ -->
1823

19-
## Bugfixes
20-
- ...
21-
22-
## Documentation
23-
- ...
24-
25-
## Maintenance
26-
- ...
24+
## Type of change
25+
<!--- Select one of the categories below by typing an `x` in the box -->
26+
- [ ] New feature / enhancement
27+
- [ ] Bug fix
28+
- [ ] Documentation
29+
- [ ] Maintenance
30+
- [ ] Other (please specify):
31+
<!--- Additionally, if you are a maintainer or reviewer, please make sure that the appropriate labels are added to this PR -->

0 commit comments

Comments
 (0)