@@ -10,15 +10,15 @@ Include a summary of major changes in bullet points:
10
10
## Additional dependencies introduced (if any)
11
11
12
12
* List all new dependencies needed and justify why. While adding dependencies that bring
13
- significantly useful functionality is perfectly fine, adding ones that
13
+ significantly useful functionality is perfectly fine, adding ones that
14
14
add trivial functionality, e.g., to use one single easily implementable
15
- function, is frowned upon. Provide a justification why that dependency is needed.
15
+ function, is frowned upon. Provide a justification why that dependency is needed.
16
16
Especially frowned upon are circular dependencies, e.g., depending on derivative
17
17
modules of pymatgen such as custodian or Fireworks.
18
18
19
19
## TODO (if any)
20
20
21
- If this is a work-in-progress, write something about what else needs
21
+ If this is a work-in-progress, write something about what else needs
22
22
to be done
23
23
24
24
* Feature 1 supports A, but not B.
@@ -33,15 +33,15 @@ Before a pull request can be merged, the following items must be checked:
33
33
- [ ] Code is in the [ standard Python style] ( https://www.python.org/dev/peps/pep-0008/ ) . The easiest way to handle this
34
34
is to run the following in the ** correct sequence** on your local machine. Start with running
35
35
[ black] ( https://black.readthedocs.io/en/stable/index.html ) on your new code. This will automatically reformat
36
- your code to PEP8 conventions and removes most issues. Then run
37
- [ pycodestyle] ( https://pycodestyle.readthedocs.io/en/latest/ ) , followed by
36
+ your code to PEP8 conventions and removes most issues. Then run
37
+ [ pycodestyle] ( https://pycodestyle.readthedocs.io/en/latest/ ) , followed by
38
38
[ flake8] ( http://flake8.pycqa.org/en/latest/ ) .
39
39
- [ ] Docstrings have been added in the [ Google docstring format] ( https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html ) .
40
40
Run [ pydocstyle] ( http://www.pydocstyle.org/en/2.1.1/index.html ) on your code.
41
41
- [ ] Type annotations are ** highly** encouraged. Run [ mypy] ( http://mypy-lang.org/ ) to type check your code.
42
42
- [ ] Tests have been added for any new functionality or bug fixes.
43
43
- [ ] All linting and tests pass.
44
44
45
- Note that the CI system will run all the above checks. But it will be much more efficient if you already fix most
46
- errors prior to submitting the PR. It is highly recommended that you use the pre-commit hook provided in the pymatgen
45
+ Note that the CI system will run all the above checks. But it will be much more efficient if you already fix most
46
+ errors prior to submitting the PR. It is highly recommended that you use the pre-commit hook provided in the pymatgen
47
47
repository. Simply ` cp pre-commit .git/hooks ` and a check will be run prior to allowing commits.
0 commit comments