Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JaGeo authored Feb 23, 2024
1 parent 31e3648 commit 4caa787
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Software for automated fitting and benchmarking of ML potentials.
Contributions are welcome. Please raise a pull request for contributions first. At least one person has to review the code. At the beginning, Janine will take care of the reviews.

# General guidelines
- variable names should use snake case.
- please use numpy docstrings
- please write unit tests (testing will be performed with pytest)
- please ensure high coverage of the code based on the tests
- variable names should be descriptive and should use snake case.
- please use numpy docstrings (use an IDE and switch on thise docstring type; you can check examples in our code base)
- please write unit tests (testing will be performed with pytest; please look into tests for examples)
- please ensure high coverage of the code based on the tests (you can test this with `coverage`)

# Commit guidelines
1. `pip install pre-commit`.
Expand Down

0 comments on commit 4caa787

Please sign in to comment.