forked from GithubBackups/healthchecks
Add more content in CONTRIBUTING
This commit is contained in:
parent
0c58a9b9ee
commit
ad886fe157
@ -1,17 +1,23 @@
|
|||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
## Dependencies
|
I'm open to feature suggestions and happy to review code contributions.
|
||||||
|
If you are planning to contribute something larger than a small, straightforward
|
||||||
|
bugfix, please open an issue so we can discuss it first. Otherwise you are risking a
|
||||||
|
"no" or a "yes, but let's do it differently" to an already implemented feature.
|
||||||
|
|
||||||
On Debian:
|
## Code Style
|
||||||
|
|
||||||
```
|
* Format your Python code with [black](https://black.readthedocs.io/en/stable/).
|
||||||
sudo apt install libpq-dev
|
* Prefer simplicity over cleverness.
|
||||||
pip3 install -r requirements.txt
|
* If you are fixing a bug or adding a feature, add a test. Run tests before
|
||||||
pip3 install markdown django
|
submitting pull requests.
|
||||||
```
|
|
||||||
|
|
||||||
## Adding Documentation
|
## Adding Documentation
|
||||||
|
|
||||||
1. Create the appropriate markdown page under `templates/docs`
|
This project uses the Markdown format for documentation. Use the `render_docs`
|
||||||
2. Add the page to `/templates/front/base_docs.html`
|
management command to generate the HTML version of the documentation. To add a new
|
||||||
3. Generate the HTML assets with `python3 manage.py render_docs` - note that the `manage.py` is in the root of the project.
|
documentation page:
|
||||||
|
|
||||||
|
1. Create the appropriate .md file under `templates/docs`
|
||||||
|
2. Generate the HTML version with `./manage.py render_docs`
|
||||||
|
3. Add the page to the navigation in `/templates/front/base_docs.html`
|
||||||
|
Loading…
x
Reference in New Issue
Block a user