Skip to content

Commit

Permalink
Added note on about black in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RandomDefaultUser committed Apr 17, 2024
1 parent 36a6c8b commit 0a8613a
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/source/CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ the core development team.
* If you're adding code that should be tested, add tests
* If you're adding or modifying examples, make sure to add them to `test_examples.py`

### Formatting code

* MALA uses `black` for code for unified code formatting
* For more info on `black` itself, see the respective
[documentation](https://github.com/psf/black)
* Currently, no automatic code reformatting will be done in the CI, thus
please ensure that your code is properly formatted before creating a pull
request

### Adding dependencies

If you add additional dependencies, make sure to add them to `requirements.txt`
Expand All @@ -98,7 +107,6 @@ they are not.
Further, in order for them to be available during the CI tests, make sure to
add _required_ dependencies to the appropriate environment files in folder `install/` and _extra_ requirements directly in the `Dockerfile` for the `conda` environment build.


## Pull Requests
We actively welcome pull requests.
1. Fork the repo and create your branch from `develop`
Expand Down

0 comments on commit 0a8613a

Please sign in to comment.