git.iko.soy/urbit.org
on cf79ea7 help sign in
urbit.org/docs/about/contributing.md
46 lines 1.7 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, if you are making a brand new page, you'll want
26it to conform to our general documentation standards. Acquire [pandoc](http://pandoc.org)
27and make sure to format your edited files with the following flags:
29 $ pandoc --standalone \
30 --from=markdown+yaml_metadata_block \
31 --atx-headers \
32 -o output.md \
33 input.md
35If you are editing an existing page, reformatting the entire page with pandoc
36will make the diff hard to read. Instead, just make sure that your edits generally
37conform to the style of the existing docs around it. For example, you'll notice
38that the paragraphs mostly wrap at column 80.
40**Note:** If you have an old version of Pandoc, it may convert the
41terminating `---` in YAML metadata to `...`, which is grounds for termination.
42Run the following one-liner to atone.
44 $ sed '1,/^$/ s/^\.\.\./---/g' input.md > output.md
46Newer versions of pandoc (1.19.2.1, for example) don't have this issue.