paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-10-30 03:56:23 -05:00
Code Issues Packages Projects Releases 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 a14f180524
commit 5f4b9fcbca
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 ## 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 ## Branches
@@ -23,7 +23,7 @@ Paperless supports python 3.8 and 3.9.
## Testing: ## 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. 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.

1
docs/extending.rst
View File

@@ -107,6 +107,7 @@ Testing and code style:
* Run ``pytest`` in the src/ directory to execute all tests. This also generates a HTML coverage * Run ``pytest`` in the src/ directory to execute all tests. This also generates a HTML coverage
report. When runnings test, paperless.conf is loaded as well. However: the tests rely on the default report. When runnings test, paperless.conf is loaded as well. However: the tests rely on the default
configuration. This is not ideal. But for now, make sure no settings except for DEBUG are overridden when testing. configuration. This is not ideal. But for now, make sure no settings except for DEBUG are overridden when testing.
* Run ``black`` to format your code.
* Run ``pycodestyle`` to test your code for issues with the configured code style settings. * Run ``pycodestyle`` to test your code for issues with the configured code style settings.
.. note:: .. note::