ares/CONTRIBUTING.md
2023-11-24 11:38:51 -06:00

25 lines
677 B
Markdown

# Contributing to Ares
Below are guidelines for contributions to Ares. For information on building and hacking on ares, see [DEVELOPERS.md](DEVELOPERS.md).
## Style
Hoon should generally follow the [Hoon Style Guide](https://docs.urbit.org/language/hoon/guides/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.