Skip to content

Commit 4aa0c25

Browse files
authoredJun 26, 2024··
Update PULL_REQUEST_TEMPLATE.md
1 parent bbcd35b commit 4aa0c25

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed
 

‎.github/PULL_REQUEST_TEMPLATE.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,27 @@ Include a summary of major changes in bullet points:
55
* Feature 1
66
* Fix 1
77

8+
89
## Additional dependencies introduced (if any)
910

1011
* List all new dependencies needed and justify why.
1112

13+
1214
## TODO (if any)
1315

1416
If this is a work-in-progress, write something about what else needs to be done.
1517

1618
* Feature 1 supports A, but not B.
1719

20+
1821
## Checklist
1922

2023
Before a pull request can be merged, the following items must be checked:
2124

2225
* [ ] Make sure your code is properly formatted. [isort](https://pycqa.github.io/isort/) and [black](https://black.readthedocs.io/en/stable/getting_started.html) are used for this purpose. The simplest way is to use [pre-commit](https://pre-commit.com). See instructions [here](https://github.com/openkim/kliff/blob/main/docs/source/contributing_guide.md#code-style).
2326
* [ ] Doc strings have been added in the [Google docstring format](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html) on your code.
24-
* [ ] Type annotations are **highly** encouraged. Run [mypy](http://mypy-lang.org) to
25-
type check your code.
27+
* [ ] Type annotations are **highly** encouraged. Run [mypy](http://mypy-lang.org) to type check your code.
2628
* [ ] Tests have been added for any new functionality or bug fixes.
2729
* [ ] All linting and tests pass.
2830

29-
Note that the CI system will run all the above checks. But it will be much more
30-
efficient if you already fix most errors prior to submitting the PR.
31+
Note that the CI system will run all the above checks. But it will be much more efficient if you already fix most errors prior to submitting the PR.

0 commit comments

Comments
 (0)
Please sign in to comment.