Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.

Latest commit

 

History

History
25 lines (14 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

25 lines (14 loc) · 1.68 KB

Contributing

If you are looking to help to with a code contribution our project uses the Rust programming language with the tokio asynchronous IO framework. If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues.

If you need help, you can ask questions IRC chat. I am hjr3 on irc.mozilla.org and freenode.

Feature Requests

To request a change to the way that the weldr works, please open an issue before starting work. New features and other significant changes must be discussed first.

Pull Requests

Pull requests are the primary mechanism we use to change weldr. GitHub itself has some great documentation on using the Pull Request feature. We use the fork and pull model described there.

A few additional guidelines:

  • Please make pull requests against the master branch. Multiple commits are fine as long as each commit has a good commit message and passes the tests.
  • Please rebase instead of merging changes from the master branch.
  • Please make sure the first line of the Git commit messages are no longer then 72 characters. The Git documentation suggests 50 characters.

For more information about good commit messages see Tbaggery or MediaWiki.

Code of Conduct

All contributors are expected to follow the Rust Code of Conduct.