Contributing

Contributions are very welcome; please contact us by email or by filing an issue in our repository. All contributors must abide by our Code of Conduct.

Actions

Setup:

$ git clone git@github.com:gvwilson/sim
$ cd sim
$ uv venv
$ source .venv/bin/activate
$ uv sync --extra dev --upgrade

Tasks:

$ task --list

build    build HTML
check    check HTML
clean    clean up
examples re-create examples
fix      fix code issues
format   format code
lint     check code
serve    serve HTML

FAQ

Do you need any help?

Yes—please see the issues in our repository.

What sort of feedback would be useful?

Everything is welcome, from pointing out mistakes in the code to suggestions for better explanations.

Can I add a new section?

Absolutely, but please reach out before doing so.

Why is this material free to read?

Because if we all give a little, we all get a lot.