Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 1.57 KB

Contributing to rustainers

🎈 Thanks for your help improving the project! We are so happy to have you!

There are opportunities to contribute to rustainers at any level. It doesn't matter if you are just getting started with Rust or are the most weathered expert, we can use your help.

No contribution is too small and all contributions are valued.

This guide will help you get started. Do not let this guide intimidate you. It should be considered a map to help you navigate the process.

Asking for General Help

If you have reviewed existing documentation and still have questions or are having problems, you can open an issue asking for help.

In exchange for receiving help, we ask that you contribute back a documentation PR that helps others avoid the problems that you encountered.

Requirements

You can use the standard Rust toolchain to work on that project.

To improve your developer experience, you can use just, and launch just to see available receipts.

Use just requirement to install all external requirement.

Commits

It is a recommended best practice to keep your changes as logically grouped as possible within individual commits. There is no limit to the number of commits any single Pull Request may have, and many contributors find it easier to review changes that are split across multiple commits.

Note that multiple commits often get squashed when they are landed.

Commit messages should follow Conventional commits.