From 86c01ab95a9337a0fe918570663649bdc0c35c5b Mon Sep 17 00:00:00 2001 From: hinto-janai Date: Fri, 14 Jun 2024 13:30:53 -0400 Subject: [PATCH] contributing: add crate naming rules (#144) * contributing.md: add crate naming rules * Update CONTRIBUTING.md Co-authored-by: SyntheticBird <118022351+SyntheticBird45@users.noreply.github.com> * edit contributing for https://github.com/Cuprate/cuprate/pull/144#discussion_r1638344193 * `monero-wire` -> `wire/`, `cuprate-monero-wire` -> `cuprate-wire` --------- Co-authored-by: SyntheticBird <118022351+SyntheticBird45@users.noreply.github.com> --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33b87809..f55bf921 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,17 @@ After that, ensure all lints, tests, and builds are successful by running: - `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`