Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 2.09 KB
Raw

Contributing

Thank you for considering to contribute to kmon!

When contributing, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Setup

  1. Fork this repository and create your branch from master.
git clone https://github.com/[username]/kmon && cd kmon
  1. Build the project for installing the dependencies.
cargo build

  1. Use cargo run command for starting the terminal interface while development.

  2. Add your tests or update the existing tests according to the changes.

cargo test --all
  1. Make sure rustfmt and clippy are passed before creating a pull request.
cargo fmt --all -- --check
cargo clippy -- -D warnings

Create a Pull Request

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

  2. Update the README.md and CHANGELOG.md with details of changes to the terminal user interface including new environment variables, command line arguments and container parameters.

  3. Increase the version number in Cargo.toml to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

  4. You may merge the Pull Request in once you have the sign-off of the two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

License

By contributing, you agree that your contributions will be licensed under GNU General Public License 3.0.