Contributor guidelines

Zinc contributor guidelines

Code formatting

Zinc follows the common rust conventions on naming and google C++ style guide on formatting. Notable changes from rust style are:

• indentation is two spaces
• 80 chars is a hard wrap unless the offending char is { or ;, you can keep it on the same line
• if you need to wrap a line, the continuation offset must be four spaces

Extensions to rust style:

• getters should be named get_attr
• keep one blank line between external crates use and local crate use
• keep use list sorted alphabetically
• if your file includes a mod reg, it must be in the end of a file but before tests, if any

Life of a PR

If the issue needs any serious prior discussion, please post it to the mailing list.

If you're done with the discussion or none is required and the issue contains all required data to work on it, mark it a ready.

If you started working on an issue or submitted a new PR, mark it as in progress. Do not use prefixes in subject (like '[WIP']).

If your PR is ready to be reviewed, mark it as ready for review. A reviewer will take a look at your code and provide some feedback. There's no need to get back to in progress state if the changes are trivial and don't require additional discussion.

You can use Waffle to simplify the process of moving the issue from one state to another.