Skip to content

Commit b7867db

Browse files
Update PR template
1 parent bbecb40 commit b7867db

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1+
<!-- **Thank you for opening a PR!** -->
12

2-
**Thank you for opening a PR!**
3+
## Description
34

4-
Here are a few important guidelines and requirements to check before your PR can be merged:
5+
<!-- Include a description of the changes and provide references to the relevant issues and/or discussions. -->
6+
7+
## Checklist
8+
9+
<!-- Here are a few important guidelines and requirements to check before your PR can be merged: -->
10+
11+
+ [ ] You have read [CONTRIBUTING.md](https://github.com/aesara-devs/aesara/blob/main/.github/CONTRIBUTING.md), the [developer start guide](https://aesara.readthedocs.io/en/latest/dev_start_guide.html), and any documentation relevant to the proposed changes (e.g. [Creating a new `Op`](https://aesara.readthedocs.io/en/latest/extend/op/creating_an_op.html) when proposing a new `Op`).
512
+ [ ] There is an informative high-level description of the changes.
613
+ [ ] The description and/or commit message(s) references the relevant GitHub issue(s).
714
+ [ ] [`pre-commit`](https://pre-commit.com/#installation) is installed and [set up](https://pre-commit.com/#3-install-the-git-hook-scripts).
815
+ [ ] The commit messages follow [these guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
916
+ [ ] 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**.
1017
+ [ ] There are tests covering the changes introduced in the PR.
1118

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.
19+
<!-- 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.
1320
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).
21+
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). -->

0 commit comments

Comments
 (0)