2024-08-22 18:11:30 +03:00
|
|
|
# Contributing to Sword
|
2023-11-24 20:38:51 +03:00
|
|
|
|
2024-08-22 18:11:30 +03:00
|
|
|
Below are guidelines for contributions to Sword. For information on building and hacking on Sword, see [DEVELOPERS.md](DEVELOPERS.md).
|
2023-02-03 22:58:27 +03:00
|
|
|
|
|
|
|
|
## Style
|
2023-11-24 20:38:51 +03:00
|
|
|
Hoon should generally follow the [Hoon Style Guide](https://docs.urbit.org/language/hoon/guides/style).
|
2023-02-03 22:58:27 +03:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2023-11-24 20:38:51 +03:00
|
|
|
|
