git.iko.soy/urbit.org
on master help sign in
part 1: contributing.md
218e0faTobias Merkle
docs/about/contributing.mdnew file+35
compare with master
unifiedsplit
@@ -0,0 +1,35 @@
1+---
2+navhome: '/docs'
3+next: True
4+sort: 4
5+title: Contributing to Urbit
6+---
7+
8+# Contributing to Urbit
9+
10+It's always a good day for pull requests! We gladly accept submissions
11+for improving our [code](https://github.com/urbit/urbit/) and
12+[documentation](https://github.com/urbit/docs/) alike.
13+
14+## Code guidelines
15+
16+Refer to [Hoon Syntax](/hoon/syntax) for an in-depth guide to good Hoon.
17+Alternatively, [browse the
18+source](https://github.com/urbit/arvo/blob/master/arvo/hoon.hoon).
19+
20+## Docs guidelines
21+
22+For documentation pull requests, acquire [pandoc](http://pandoc.org) and
23+format your edited files with the following flags:
24+
25+ $ pandoc --standalone \
26+ --from=markdown+yaml_metadata_block \
27+ --atx-headers \
28+ -o output.md \
29+ input.md
30+
31+**Note:** Pandoc will convert the terminating `---` in YAML metadata to
32+`...`, which is grounds for termination. Run the following one-liner to
33+atone.
34+
35+ $ sed '1,/^$/ s/^.../---/g' input.md > output.md