roc/CONTRIBUTING.md

Contributing

Code of Conduct

We are committed to providing a friendly, safe and welcoming environment for all. Make sure to take a look at the Code of Conduct!

Building from Source

Check Building from source for instructions.

Running Tests

Most contributors execute the following commands befor pushing their code:

cargo test
cargo fmt --all -- --check
cargo clippy --workspace --tests -- --deny warnings

Execute cargo fmt --all to fix the formatting.

Contribution Tips

• If you've never made a pull request on github before, this will be a good place to start.
• Create an issue if the purpose of a struct/field/type/function/... is not immediately clear from its name or nearby comments.
• You can find good first issues here.
• Before making your first pull request, definitely talk to an existing contributor on Roc Zulip first about what you plan to do! This can not only avoid duplicated effort, it can also avoid making a whole PR only to discover it won't be accepted because the change doesn't fit with the goals of the language's design or implementation.
• Fork the repo so that you can apply your changes first on your own copy of the roc repo.
• It's a good idea to open a draft pull request as you begin working on something. This way, others can see that you're working on it, which avoids duplicate effort, and others can give feedback sooner rather than later if they notice a problem in the direction things are going. Click the button "ready for review" when it's ready.
• All your commits need to be signed to prevent impersonation:
  1. If you have a Yubikey, follow guide 1, guide 2 and skip the steps below.
  2. Make a key to sign your commits..
  3. Configure git to use your key.
  4. Make git sign your commits automatically:

  git config --global commit.gpgsign true
  

Can we do better?

Feel free to open an issue if you think this document can be improved or is unclear in any way.