Skip to content

Commit a162fef

Browse files
michaelosthegericardoV94
authored andcommitted
Align PR template with PyMC
1 parent e8159b9 commit a162fef

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
1+
<!-- !! Thank your for opening a PR !! -->
12

2-
**Thank you for opening a PR!**
3+
### Motivation for these changes
4+
...
35

4-
Here are a few important guidelines and requirements to check before your PR can be merged:
5-
+ [ ] There is an informative high-level description of the changes.
6-
+ [ ] The description and/or commit message(s) references the relevant GitHub issue(s).
7-
+ [ ] [`pre-commit`](https://pre-commit.com/#installation) is installed and [set up](https://pre-commit.com/#3-install-the-git-hook-scripts).
8-
+ [ ] The commit messages follow [these guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
9-
+ [ ] The commits correspond to [_relevant logical changes_](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes), and there are **no commits that fix changes introduced by other commits in the same branch/BR**.
10-
+ [ ] There are tests covering the changes introduced in the PR.
6+
### Implementation details
7+
...
118

12-
Don't worry, your PR doesn't need to be in perfect order to submit it. As development progresses and/or reviewers request changes, you can always [rewrite the history](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#_rewriting_history) of your feature/PR branches.
139

14-
If your PR is an ongoing effort and you would like to involve us in the process, simply make it a [draft PR](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests).
10+
### Checklist
11+
+ [ ] Explain motivation and implementation 👆
12+
+ [ ] Make sure that [the pre-commit linting/style checks pass](https://docs.pymc.io/en/latest/contributing/python_style.html).
13+
+ [ ] Link relevant issues, preferably in [nice commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
14+
+ [ ] The commits correspond to [_relevant logical changes_](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes). Note that if they don't, we will [rewrite/rebase/squash the git history](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#_rewriting_history) before merging.
15+
+ [ ] Are the changes covered by tests and docstrings?
16+
+ [ ] Fill out the short summary sections 👇
17+
18+
## Major / Breaking Changes
19+
- ...
20+
21+
## Bugfixes / New features
22+
- ...
23+
24+
## Docs / Maintenance
25+
- ...

0 commit comments

Comments
 (0)