Skip to content

Latest commit

 

History

History
115 lines (77 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

115 lines (77 loc) · 2.48 KB
Raw

Contribution guidelines

First off, thank you for considering contributing to rhino-system.

If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.

Reporting issues

Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.

Pull requests

Try to do one pull request per change.

Committing

Follow the Conventional Commits specification for your commit messages.

Updating the changelog

Update the changes you have made in CHANGELOG file under the Unreleased section.

Add the changes of your pull request to one of the following subsections, depending on the types of changes defined by Keep a changelog:

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

If the required subsection does not exist yet under Unreleased, create it!

Developing

Set up

First fork the project, and clone your fork to your machine.

You'll need to install Just next. Think of it like the make command.

After you've installed Just, run the following command to setup your development environment:

just # or `just setup-dev`

That will install the following development tools to your machine:

  • Nightly rustfmt for formatting the code in the project.
  • pre-commit for pre-commit hooks, which run before you commit to make sure that your commit is up to standards.
  • codespell for spell checking.

Then run the tests to verify that your development environment is setup correctly.

just test

Useful Commands

  • List all Just recipes:

    just -l

  • Build the project

    just build

  • Run all checks (spellcheck, clippy, test, fmt):

    just check

    • Run the spell checker:

      just spellcheck

    • Run Clippy:

      just clippy

    • Run all tests:

      just test

    • Format the code in the project

      just fmt