Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.49 KB

Contributing to new-rust-project

Code of Conduct

This project shares many of the values of the Rust community as a whole. To this end, please read the Code of Conduct included with this project -- it serves as the official guideline of expected behavior in general when collaborating on this project.

FAQ

"I have an issue/feature request!"

Awesome! Please submit an issue to the tracker on Github.

"What will my pull requests need to be accepted?"

Whenever you contribute to this project, your PR should have at least the following:

  • An explanation of what your changes are. Make sure your PR summary and the Git commit messages will allow people to follow what you've done easily!
  • A justification of the changes you're making -- make your pitch, and tell us why your change is valuable!
  • An update to the test harness in the tests directory, where applicable.
  • An update to the CHANGELOG, where applicable.

"I want to make a feature/pull request, but I'm not sure how it'll be received."

If it's relatively minor, just file your choice of a PR or issue. If there are design implications for a given pull request and you want to test the waters for concerns the project will have and/or how it will be received, feel free to make an issue on the tracker on Github to open a discussion.