Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 1.97 KB
Raw

Contributing

Thank you for considering contributing to nvrs ❤️

If, while viewing the code, you find any parts unclear or unexplained, please open an issue with a documentation request.

Note that we have a Code of Conduct. Please follow it in all your interactions with the project.

Workflow

  1. Fork this repository and create your branch from main.

  2. Clone your forked repository.

git clone https://github.com/adamperkowski/nvrs && cd nvrs
# OR
git clone git@github.com:adamperkowski/nvrs && cd nvrs
  1. Make sure that you have Rust installed and build the project.
cargo build

  1. Start committing your changes. Follow the conventional commit specification.

  2. Make sure rustfmt and clippy don't complain about your changes.

  3. If needed, update the changelog. Make sure that you have git-cliff installed.

git-cliff > CHANGELOG.md
git add CHANGELOG.md
git commit -m "changelog for $(git rev-parse --short HEAD)"

Submitting Changes

  1. Ensure that you updated the documentation and filled the Pull Request template according to the changes you made.

  2. Push the changes and open a Pull Request.

  3. Wait for review from the project's CODE OWNER. Update the Pull Request accordingly.

  4. Once the Pull Request is approved, it will be merged into the main branch.