Skip to content

Commit 5aa5007

Browse files
committed
Add pull request template
1 parent 2353364 commit 5aa5007

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Description
2+
3+
Add your description here, if it fixes a particular issue please provide a
4+
[link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword=)
5+
to the issue.
6+
7+
# Checklist
8+
9+
- [ ] Commit sequence broadly makes sense
10+
- [ ] Commits have useful messages
11+
- [ ] New tests are added if needed and existing tests are updated
12+
- [ ] Any changes are noted in the
13+
[changelog](https://github.com/input-output-hk/cardano-db-sync/blob/master/cardano-db-sync/CHANGELOG.md)
14+
- [ ] Code is formatted with [`fourmolu`](https://github.com/fourmolu/fourmolu)
15+
(which can be run with `scripts/fourmolize.sh`
16+
- [ ] Self-reviewed the diff
17+
18+
# Migrations
19+
20+
- [ ] The pr causes a
21+
[breaking change](https://github.com/input-output-hk/cardano-db-sync/blob/master/doc/migrations.md)
22+
of type a,b or c
23+
- [ ] If there is a breaking change, the pr includes a database migration and/or a fix process for
24+
old values, so that upgrade is possible
25+
- [ ] Resyncing and running the migrations provided will result in the same database semantically
26+
27+
If there is a breaking change, especially a big one, please add a justification here. Please elaborate
28+
more what the migration achieves, what it cannot achieve or why a migration is not possible.

0 commit comments

Comments
 (0)