cuprate-hinto-janai/CONTRIBUTING.md

Contributing to Cuprate

Introduction

Thank you for wanting to help out! Cuprate is in the stage where things are likely to change quickly, so it's recommend you join our Matrix room.

Making a PR

Once you have found something you would like to work on by either looking at the open issues or joining Cuprate's Matrix room and asking it's recommended to make your interest on working on that thing known so people don't duplicate work.

When you are at a stage where you would like feedback you can open a draft PR, keep in mind that feedback may take time especially if the change is large. Once your PR is at the stage where you feel it's ready to go, open it for review.

Passing CI

The first 3 steps to CI are formatting, typo, and documentation checking.

Check if your changes are formatted, typo-free, and documented correctly by running:

• cargo fmt --all --check
• typos
• RUSTDOCFLAGS='-D warnings' cargo doc --workspace --all-features

typos can be installed with cargo from: https://github.com/crate-ci/typos.

After that, ensure all lints, tests, and builds are successful by running:

• cargo clippy --workspace --all-features --all-targets -- -D warnings
• cargo fmt --all
• cargo test --all-features --workspace
• cargo build --all-features --all-targets --workspace

Crate names

All of Cuprate's crates (libraries) are prefixed with cuprate-.

All directories containing crates however, are not. For example:

Crate Directory	Crate Name
storage/database	cuprate-database
net/levin	cuprate-levin
net/wire	cuprate-wire

Coding guidelines

• // Comment like this. and not //like this
• Use TODO instead of FIXME
• Avoid unsafe
• Sort imports as core, std, third-party, Cuprate crates, current crate.
• Follow the Rust API Guidelines
• Break the above rules when it makes sense

Keeping track of issues and PRs

The Cuprate GitHub repository has a lot of issues and PRs to keep track of. Cuprate makes use of generic labels and labels grouped by a prefixes to help with this.

Some labels will be automatically added/removed if certain file paths have been changed in a PR.

The following section explains the meaning of various labels used. This section is primarily targeted at maintainers. Most contributors aren't able to set these labels.

Labels	Description	Example
A-	The area of the project an issue relates to.	A-storage, A-rpc, A-docs
C-	The category of an issue.	C-cleanup, C-optimization
D-	Issues for diagnostics.	D-confusing, D-verbose
E-	The experience level necessary to fix an issue.	E-easy, E-hard
I-	The importance of the issue.	I-crash, I-memory
O-	The operating system or platform that the issue is specific to.	O-windows, O-macos, O-linux
P-	The issue priority. These labels can be assigned by anyone that understand the issue and is able to prioritize it, and remove the [I-prioritize] label.	P-high, P-low

Books

Cuprate has various documentation books whose source files live in books/.

Please contribute if you found a mistake! The files are mostly markdown files and can be easily edited. See the books/ directory for more information.