aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
diff options
context:
space:
mode:
authorTrygve Aaberge <trygveaa@gmail.com>2021-06-23 19:25:28 +0200
committerTrygve Aaberge <trygveaa@gmail.com>2021-06-23 19:25:28 +0200
commita87c405a434e2f4bf8d7e7d5fe5fb5061a74e82b (patch)
treeb72b83988110740a3d593fd71cfb3821bf1caea1 /docs/contributing.md
parentadb1029977169ac665041e2e95613c531808875e (diff)
downloadwee-slack-a87c405a434e2f4bf8d7e7d5fe5fb5061a74e82b.tar.gz
Document how to format and lint the code
Fixes #842
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 963dbf6..f9dfc0e 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -24,10 +24,28 @@ $ pipenv install --dev
The rest of this document assumes that the development environment has been
activated, and that you have the latest development dependencies installed.
+## Formatting
+
+The code is formatted with [`black`](https://black.readthedocs.io/). To format
+all the files, first navigate to the project root, and then execute:
+
+```
+$ black .
+```
+
+## Linting
+
+The code is linted with [`flake8`](https://flake8.pycqa.org/). To lint all the
+files, first navigate to the project root, and then execute:
+
+```
+$ flake8 .
+```
+
## Testing
-Tests are executed with `pytest`. To run the tests, first navigate to the
-project root, and then execute:
+Tests are executed with [`pytest`](https://pytest.org/). To run the tests,
+first navigate to the project root, and then execute:
```
$ pytest