Skip to content

Commit 369d021

Browse files
committed
Update PR template
1 parent fa7cf85 commit 369d021

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

.github/pull_request_template.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,15 @@
77
- [ ] Bug fix in a **backwards-compatible** manner.
88
- [ ] New feature in a **backwards-compatible** manner.
99
- [ ] Breaking change: bug fix or new feature that involve incompatible API changes.
10+
- [ ] Other (e.g. doc update, configuration, etc)
1011

1112
### Checklist
1213

13-
1. [ ] Add the change to the `CHANGELOG.rst` file in the `Unreleased` section under the most fitting heading: `Added`, `Changed`, `Removed`.
14-
1. [ ] Run all tests on your computer (i.e. `invoke test`).
15-
1. [ ] If you add new functions/classes, check that:
16-
1. [ ] Are available on a second-level import, e.g. `compas_fab.robots.Configuration`.
17-
1. [ ] Add unit tests (especially important for algorithm implementations).
14+
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
15+
16+
- [ ] I added a line to the `CHANGELOG.rst` file in the `Unreleased` section under the most fitting heading (e.g. `Added`, `Changed`, `Removed`).
17+
- [ ] I ran all tests on my computer and it's all green (i.e. `invoke test`).
18+
- [ ] I ran lint on my computer and there are no errors (i.e. `invoke link`) .
19+
- [ ] I added new functions/classes and made them available on a second-level import, e.g. `compas_fab.robots.Configuration`.
20+
- [ ] I have added tests that prove my fix is effective or that my feature works.
21+
- [ ] I have added necessary documentation (if appropriate)

0 commit comments

Comments
 (0)