Skip to content

Commit 3de713a

Browse files
authored
Merge pull request #236 from LinasKo/docs/contribution-sections
CONTRIBUTING.md: sections, mkdocs serve, container rebuild
2 parents a253fe7 + de03670 commit 3de713a

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

CONTRIBUTING.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ If you want to extend our Python library or if you find a bug, please open a PR!
55

66
Also be sure to test your code the `unittest` command at the `/root` level directory.
77

8-
Run tests:
8+
### Devcontainer
9+
10+
This project comes with a [convenient devcontainer](https://www.loom.com/share/a183c4a351ed4700a79476fedf08ab9b) that makes it easier to run tests and has black configured to run on save.
11+
12+
On rare occasions a full rebuild is needed, you can do it in VSCode by pressing `Ctrl+Shift+P` and running `Dev Containers: Rebuild Container`.
13+
14+
### Tests
915

1016
```bash
1117
python -m unittest
@@ -39,4 +45,12 @@ make check_code_quality
3945

4046
**Note** These tests will be run automatically when you commit thanks to git hooks.
4147

42-
**Note** This project also comes with a [convenient devcontainer](https://www.loom.com/share/a183c4a351ed4700a79476fedf08ab9b) that makes it easier to run tests and has black configured to run on save.
48+
### Docs
49+
50+
The docs can be built with `mkdocs serve`.
51+
52+
Before that, install the dependencies:
53+
54+
```python
55+
python -m pip install mkdocs mkdocs-material mkdocstrings mkdocstrings[python]
56+
```

0 commit comments

Comments
 (0)