Skip to content

CONTRIBUTING.md: sections, mkdocs serve, container rebuild #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 31, 2024
Merged

CONTRIBUTING.md: sections, mkdocs serve, container rebuild #236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ If you want to extend our Python library or if you find a bug, please open a PR!

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

Run tests:
### Devcontainer

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.

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`.

### Tests

```bash
python -m unittest
Expand Down Expand Up @@ -39,4 +45,12 @@ make check_code_quality

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

**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.
### Docs

The docs can be built with `mkdocs serve`.

Before that, install the dependencies:

```python
python -m pip install mkdocs mkdocs-material mkdocstrings mkdocstrings[python]
```