Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (69 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

104 lines (69 loc) · 3.53 KB

Contributing

Filing an Issue

If you are trying to use brog and run into an issue- please file an issue! We'd love to get you up and running, even if the issue you have might not be directly related to the code in brog. This tool seeks to make deploying and managing container derived operating systems simple, so any sorts of feedback on usability, usecases, or other aspects of this general problem space are welcome!

When filing an issue, do your best to be as specific as possible. Include the version of cargo you are using (cargo --version), the version of Rust you are using (rustc --version) and your operating system and version. The faster was can reproduce your issue, the faster we can fix it for you!

Testing your code

Unit tests

After writing your patch, or finishing a feature, make sure that your code does not collides with the existing code by executing the unit tests.

To execute the tests performed in the CI environment use the following features included in cargo:

cargo test
cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings

cargo test will execute the unit tests included in the tests directory. If all the lights are green then you will want to execute .

cargo fmt will ensure all your code is formatted correctly. See Configuring rustfmt for set up.

cargo clippy enforces Rust community best practices on code structure.

Commits

All commits MUST be signed with a Developer Certificate of Origin.

This is usually done by adding the -s flag to the commit command.

git commit -s -m"feat: a rad feature"

This isn't negotiable but if you forget to add it the error in the CI will provide guidance on how you can apply it retrospectively.

We like Conventional Commits and would encourage regular committers to use it.

Submitting a PR

If you are considering filing a pull request, make sure that there's an issue filed for the work you'd like to do. There might be some discussion required! Filing an issue first will help ensure that the work you put into your pull request will get merged.

Before you submit your pull request, check that you have completed all of the steps mentioned in the pull request template. Link the issue that your pull request is responding to, and run the commands outlined in the unit test section.

Configuring rustfmt

Before submitting code in a PR, make sure that you have formatted the codebase using rustfmt. rustfmt is a tool for formatting Rust code, which helps keep style consistent across the project. If you have not used rustfmt before, here's how to get setup:

1. Use Stable Toolchain

Use the rustup override command to make sure that you are using the stable toolchain. Run this command in the quadit directory you cloned.

rustup override set stable

2. Add the rustfmt component

Install the most recent version of rustfmt using this command:

rustup component add rustfmt --toolchain stable

3. Running rustfmt

To run rustfmt, use this command:

cargo fmt

Conduct

We expect everyone who participates in this project in anyway to be friendly, open-minded, and humble. We have a Code of Conduct, and expect you to have read it. If you have any questions or concerns, feel free to reach out to Anton Whalley, antonwhalley@yahoo.com.