diff options
Diffstat (limited to 'On-Style.md')
-rw-r--r-- | On-Style.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/On-Style.md b/On-Style.md new file mode 100644 index 0000000..9a947cf --- /dev/null +++ b/On-Style.md @@ -0,0 +1,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. :) + |