Shellfirm is open source and we love to receive contributions from our community — you! There are many ways to contribute, from writing more sensitive patterns, improving the documentation, submitting bug reports and feature requests or writing code.
The preferred and easiest way to contribute changes to the project is to fork it on GitHub, and then create a pull request to ask us to pull your changes into our repo. We use GitHub's pull request workflow to review the contribution, and either ask you to make any refinements needed or merge it and make them ourselves.
Your PR must also:
- be based on the
mainbranch - adhere to the code style
- pass the test suites
- check documentation
- add new patterns
In shellfirm we have few test suite flows that need to pass before merging to master.
run the following command:
cargo xtask testTo capture the snapshots test we using insta rust project. you can see the snapshot changes / new snapshot by running the command:
cargo insta test --reviewcargo xtask clippycargo xtask fmtWe use the standard Rust code style, and enforce it with rustfmt/cargo fmt.
A few code style options are set in the .rustfmt.toml file, and some of them are not stable yet and require a nightly version of rustfmt.
Generate and open shellfirm to make sure that your documentation os current
cargo xtask docs-preview