Merge pull request #18 from urbit/eamsden/CONTRIBUTING

Add brief CONTRIBUTING.md file
This commit is contained in:
Edward Amsden 2023-02-04 08:47:41 -06:00 committed by GitHub
commit 2ab4070e1a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

21
rust/ares/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,21 @@
# Contributing to New Mars
## Style
Hoon should generally follow the kernel style.
Rust code must pass `cargo fmt --check`.
## Branch naming
Please name your branch `<your gh username>/<something descriptive>`:
An exception is given if you have established use of a different personal prefix
(e.g. your first name) throughout the codebase.
Examples:
- `eamsden/cap-jet`
- `philip/optimized-jam-algorithm`
## PR reviews
Don't merge without them, don't forget to do them for others.