Cuprate/cuprate
Cuprate/cuprate
1
0
Fork 0
mirror of https://github.com/Cuprate/cuprate.git synced 2024-12-22 03:29:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

contributing: add crate naming rules (#144)

Browse source 
* 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>
This commit is contained in:
hinto-janai 2024-06-14 13:30:53 -04:00 committed by GitHub
parent acd5380256
commit 86c01ab95a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -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`