mirror of
https://github.com/hinto-janai/cuprate.git
synced 2024-12-23 12:09:57 +00:00
d21160868c
* update `books/` * update CONTRIBUTING.md * .gitignore: ignore built books * add dummy `books/architecture/` * remove some changes from CONTRIBUTING.md out of scope, will be in another PR * add docs/books to LICENSE * formatting
71 lines
3.7 KiB
Markdown
71 lines
3.7 KiB
Markdown
# 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](https://matrix.to/#/#cuprate:monero.social).
|
|
|
|
## 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](https://matrix.to/#/#cuprate:monero.social)
|
|
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`
|
|
|
|
## 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](https://rust-lang.github.io/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](https://github.com/Cuprate/cuprate/tree/main/.github/labeler.yml) 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`
|
|
|
|
[A-]: https://github.com/Cuprate/cuprate/labels?q=A
|
|
[C-]: https://github.com/Cuprate/cuprate/labels?q=C
|
|
[D-]: https://github.com/Cuprate/cuprate/labels?q=D
|
|
[E-]: https://github.com/Cuprate/cuprate/labels?q=E
|
|
[I-]: https://github.com/Cuprate/cuprate/labels?q=I
|
|
[O-]: https://github.com/Cuprate/cuprate/labels?q=O
|
|
[P-]: https://github.com/Cuprate/cuprate/labels?q=P
|
|
|
|
## Books
|
|
Cuprate has various documentation books whose source files live in [`books/`](https://github.com/Cuprate/cuprate/tree/main/books).
|
|
|
|
Please contribute if you found a mistake! The files are mostly [markdown](https://wikipedia.org/wiki/Markdown) files and can be easily edited. See the `books/` directory for more information.
|