ares/CONTRIBUTING.md
Edward Amsden a7005c7049 Ares -> Sword (#12)
* Update README.md

* Rename ares -> sword

* Workspace

* Cargo-only CI
2024-08-22 10:46:38 -05:00

680 B

Contributing to Sword

Below are guidelines for contributions to Sword. For information on building and hacking on Sword, see DEVELOPERS.md.

Style

Hoon should generally follow the Hoon Style Guide.

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.