You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+5-4
Original file line number
Diff line number
Diff line change
@@ -5,26 +5,27 @@ Include a summary of major changes in bullet points:
5
5
* Feature 1
6
6
* Fix 1
7
7
8
+
8
9
## Additional dependencies introduced (if any)
9
10
10
11
* List all new dependencies needed and justify why.
11
12
13
+
12
14
## TODO (if any)
13
15
14
16
If this is a work-in-progress, write something about what else needs to be done.
15
17
16
18
* Feature 1 supports A, but not B.
17
19
20
+
18
21
## Checklist
19
22
20
23
Before a pull request can be merged, the following items must be checked:
21
24
22
25
*[ ] 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).
23
26
*[ ] 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.
26
28
*[ ] Tests have been added for any new functionality or bug fixes.
27
29
*[ ] All linting and tests pass.
28
30
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