smokephil/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-12-06 06:45:05 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add black to docs and CONTRIBUTING

Browse source
This commit is contained in:
Quinn Casey 2022-02-27 12:35:26 -08:00
parent 9b42c0aa50
commit c0ce6e28d4
2 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -11,7 +11,7 @@ If you want to implement something big:
## Python
Paperless supports python 3.8 and 3.9.
Paperless supports python 3.8 and 3.9. We format Python code with [Black](https://github.com/psf/black).
## Branches
@ -23,7 +23,7 @@ Paperless supports python 3.8 and 3.9.
## Testing:
Please test your code! I know it's a hassle, but it makes sure that your code works now and will allow us to detect regressions easily.
Please format and test your code! I know it's a hassle, but it makes sure that your code works now and will allow us to detect regressions easily.
To test your code, execute `pytest` in the src/ directory. This also generates a html coverage report, which you can use to see if you missed anything important during testing.