You will need the source of rust-spice to start contributing on the codebase. You will need to fork the project, clone your forked repository and place yourself in its directory.
If you are new to GitHub collaboration, you can refer to the Forking Projects Guide.
Replace USERNAME to match your forked repository.
git clone git@github.com:USERNAME/rust-spice.git
cd rust-spicerust-spice uses pre-commit to make sure that you don't
accidentally commit code that does not follow the coding style. The codebase
will be check against the run of the tests, the build of the documentation, the
preparation of publication. But also the fmt, check and clippy tools from
cargo, and few other git related and filesystem checks. These can be seen in
the pre-commit config file. You can install the hook script
that will check that everything is in order:
pre-commit installThe main branch (main) is the version of the code users get when they install
the library from cargo. The development branch (dev) is where
the code gets updated and validated before being merged into the main branch
(main).
Thus, all pull requests, unless otherwise instructed, need to be accepted into
the development branch (dev).
Be sure that your pull request contains tests and documentation that covers the changed or added code.
Thank you for your time contributing!!