urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2024-11-27 18:34:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

contributing: touch up code style section

Browse Source 
Suggests contributors mimic recent Hoon code, rather than only %ford in
particular.
This commit is contained in:
Jared Tobin 2019-08-28 12:08:17 -02:30
parent 2132f13d29
commit 8f9af91d66
No known key found for this signature in database
GPG Key ID: 0E4647D58F8A69E4
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -131,6 +131,8 @@ breach network continuity in order to release large changes that are difficult
to push out over-the-air. Contributions to Vere, or non-OTA-able updates to to push out over-the-air. Contributions to Vere, or non-OTA-able updates to
Arvo, will find their way into releases before terribly long. Arvo, will find their way into releases before terribly long.
## Code style
The urbit project uses two-space indentation and avoids tab characters. The urbit project uses two-space indentation and avoids tab characters.
In C code, it should not be too difficult to mimic the style of the code In C code, it should not be too difficult to mimic the style of the code
around you, which is just fairly standard K&R with braces on every around you, which is just fairly standard K&R with braces on every
@ -138,12 +140,9 @@ compound statement. One thing to watch out for is top-level sections in
source files that are denoted by comments and are actually indented one source files that are denoted by comments and are actually indented one
level. level.
Hoon will be a less familiar language to many contributors. More details are Hoon will be a less familiar language to many contributors. Until we publish
forthcoming; for now, the `%ford` vane (in an 'official' style guide, the best advice is again to mimic the code around
[`pkg/arvo/sys/vane/ford.hoon`][ford]) is some of the highest quality code in you. In general: the more recent the code, the more standard the style.
the kernel.
[ford]: https://github.com/urbit/urbit/blob/master/pkg/arvo/sys/vane/ford.hoon
## Kernel development ## Kernel development