Contributing

Contributions are welcome and accepted as pull requests on GitHub. Feel free to use issues to report bugs, missing documentation or suggest improvements of the project.

Local environment

Nix

The repository contains a Nix flake to easily setup a development environment:

nix develop

Most notably, it handles hwloc install on both MacOs and Linux, as well as the libraries bevy depends on on Linux.

Pre-commit hook

The repository contains a pre-commit hook config file. It will run basic checks that the CI performs on each PRs and commits merged to the main branch. To use it:

pip install pre-commit # or whichever package manager
pre-commit install
pre-commit run # test it!

While it is not exhaustive (most notably, it excludes honeycomb-render due to compile time), it is a good local proxy of the CI for core and kernel crates development.

The hook can be bypassed by using the --no-verify option to git commit.

Documentation

Note that a most of the code possess documentation, including private modules / items / sections. You can generate the complete documentation by using the following instructions:

mdbook serve --open user-guide/

cargo +nightly doc --all --all-features --no-deps --document-private-items