Add CONTRIBUTING.nd & requirements-dev.txt
This commit is contained in:
parent
e31104d038
commit
e2d412c7d0
25
CONTRIBUTING.md
Normal file
25
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
; SHARED on https://pad.cas.cat/usody-devicehub-contributing
|
||||||
|
|
||||||
|
# Contributing to devicehub
|
||||||
|
|
||||||
|
## Writing code
|
||||||
|
|
||||||
|
### Coding style
|
||||||
|
|
||||||
|
#### Python style
|
||||||
|
- Unless otherwise specified, follow [PEP 8](https://www.python.org/dev/peps/pep-0008). Use [flake8](https://pypi.org/project/flake8/) to check for problems in this area.
|
||||||
|
- Use [isort](https://github.com/PyCQA/isort#readme) to automate import sorting.
|
||||||
|
|
||||||
|
To automatize this work just configure `pre-commit` hooks in your development environment:
|
||||||
|
```bash
|
||||||
|
# on your virtual environment
|
||||||
|
pip install -r requirements-dev.txt
|
||||||
|
pre-commit install
|
||||||
|
```
|
||||||
|
|
||||||
|
#### HTML (templates)
|
||||||
|
- Template file names should be all lowercase, using underscores instead of camelCase.
|
||||||
|
|
||||||
|
Do this: `device_detail.html`
|
||||||
|
|
||||||
|
Don't do this: `DeviceDetail.html`, `Device-detail.html`
|
4
requirements-dev.txt
Normal file
4
requirements-dev.txt
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
black
|
||||||
|
isort
|
||||||
|
flake8
|
||||||
|
pre-commit
|
Reference in a new issue