File tree 1 file changed +19
-0
lines changed
1 file changed +19
-0
lines changed Original file line number Diff line number Diff line change @@ -25,6 +25,25 @@ Download the pre-trained model for mapping recommendations from [here](https://d
25
25
## Documentation
26
26
See our examples [ here] ( https://github.com/VIDA-NYU/bdi-kit/tree/devel/examples ) .
27
27
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
+ ```
28
47
29
48
## Folder Structure
30
49
You can’t perform that action at this time.
0 commit comments