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.

Your PR will be reviewed and the PR will either be merged or some changes may be requested. If changes were requested, please indicate when the PR has been updated by posting a comment containing "r?".

Label guidelines for project members

Ready is used to indicate that an issue contains enough information to be started.

In progress is for issues that someone is actively working on, or for PRs that are still being developed.

Ready for review is for PRs that are ready to be merged and need to be reviewed. If any substantial changes are required as a result of the review, the label should be changed to in progress.

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