git.iko.soy/urbit.org
on 6d45ede help sign in
urbit.org/docs/about/contributing.md
38 lines 1.2 kB history raw
1---
2navhome: '/docs'
3next: True
4sort: 4
5title: Contributing to Urbit
6---
8# Contributing to Urbit
10It's always a good day for pull requests! We gladly accept submissions
11for improving our [code](https://github.com/urbit/urbit/) and
12[documentation](https://github.com/urbit/docs/) alike.
14## Code guidelines
16Our official guide to contributing can be found
17[here](https://github.com/urbit/urbit/blob/master/CONTRIBUTING.md),
18which is most useful for large and low-level changes. For simpler
19revisions, refer to [Hoon Syntax](../../hoon/syntax) for an in-depth guide to
20good Hoon. Alternatively, [browse the
21source](https://github.com/urbit/arvo/blob/master/arvo/hoon.hoon).
23## Docs guidelines
25For documentation pull requests, acquire [pandoc](http://pandoc.org) and
26format your edited files with the following flags:
28 $ pandoc --standalone \
29 --from=markdown+yaml_metadata_block \
30 --atx-headers \
31 -o output.md \
32 input.md
34**Note:** Pandoc will convert the terminating `---` in YAML metadata to
35`...`, which is grounds for termination. Run the following one-liner to
36atone.
38 $ sed '1,/^$/ s/^\.\.\./---/g' input.md > output.md