Skip to content

Commit 9a42107

Browse files
committed
Updated README.md with code formatting instructions
1 parent 195fa92 commit 9a42107

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,25 @@ Download the pre-trained model for mapping recommendations from [here](https://d
2525
## Documentation
2626
See our examples [here](https://github.com/VIDA-NYU/bdi-kit/tree/devel/examples).
2727

28+
## Contributing
29+
We format code using the [black](https://black.readthedocs.io/en/stable/) code formatter.
30+
The CI runs for every pull request and will fail if code is not properly formatted.
31+
To make sure formatting is correct, you can do the following steps.
32+
33+
Make sure you have black installed:
34+
```
35+
pip install black
36+
```
37+
38+
To format the code, anyone can use the command before committing your changes:
39+
```
40+
make format
41+
```
42+
43+
Or you can use the black command directly:
44+
```
45+
black ./bdikit/
46+
```
2847

2948
## Folder Structure
3049

0 commit comments

Comments
 (0)