summary refs log tree commit diff
path: root/On-Style.md
blob: 9a947cf10708a2d95a8c224becfb471686943175 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
A style guide is a list of decisions we've made, that we want to be consistent
about going forwards. It does not need to be comprehensive of all possible
issues, nor does it need to confine itself to trivial topics such as
formatting. It's a tool for ourselves so we don't forget where we've been, and
can avoid solving the same problems again.

If you're collaborating with us on something, don't be shy about adding to
this guide. Things written here do impose some burden, but the hope is that
they lessen other burdens in the long run. Use your judgement about what's
worth it.

Please fix style issues in existing code as you encounter them. Style is
aspirational, a journey not a destination. :)