Contribution Guide

7. Contribution Guide#

We are happy to accept pull requests and issues from any contributors. Please note that we try to maintain a consistent quality standard.

7.1. Git Considerations#

Separate subject from body with a blank line
Limit the subject line to 72 characters
Capitalize the subject line
Do not end the subject line with a period
Use the imperative mood in the subject line
Use the body to explain what and why vs. how

For further information please see the excellent guide by Chris Beams.

7.2. Coding Style#

7.2.1. General#

Consistent code style is important. We try to follow existing style conventions, as much as possible:

For RTL we adhere to the lowRISC Verilog Coding Style Guide.
For C/C++ we follow the LLVM’s style guide., please note the clang-format in the projects root.
For Python code we follow the official PEP8 style guide.
Use the EditorConfig to format all files correctly.

Please make sure that any code you submit is adhering to the correct standard.

7.2.2. About the Richie Toolchain#

The Richie Toolchain leverages linters to automatically analyze various code sources and detect bugs, convention violations and style guidelines. More information is available in the corresponding here.