Project Charter

Foreword

This file contains the Mithril Project Charter, including but not limited to coding standards and best practices when contributing.

Coding Standards

Rust

• Use rustfmt to format the code before submitting a commit.

• This can be easily done on saving files in your IDE, such as in Visual Studio with the Rust Extension.

Why

It helps the team keep a clean and neat codebase and straightforward commits diffs

Git

Commit message format

Here are seven rules for great git commit messages:

1. Separate subject from body with a blank line

2. Limit the subject line to 50 characters (soft limit)

3. Capitalize the subject line

4. Do not end the subject line with a period

5. Use the imperative mood in the subject line and suffix with ticket number if applicable

6. Wrap the body at 72 characters (hard limit)

7. Use the body to explain what and why vs. how

Why

Git commit messages are our only source of why something was changed the way it was changed. So we better make the readable, concise and > detailed (when required).

Thanks to the Hydra team for these Git guidelines! Hydra Wiki