From 6b77614ba2e2b2671b8a5dc6c3c5ecf3f1e27569 Mon Sep 17 00:00:00 2001 From: jethro larson Date: Thu, 9 Jun 2016 15:18:51 -0700 Subject: [PATCH] Added the start of a styleguide --- contributing.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..5b4b72f --- /dev/null +++ b/contributing.md @@ -0,0 +1,25 @@ +# Contributing + +This project is a work in progress. Contributions are very welcome. + +That said, we'd like to maintain some consistency across the document. + +## Style guide +1. Every definition should include at least one JavaScript code example. +1. Definitions should be written using the simplest language possible. Every word should tell. +1. Target programmers that have no functional programming experience. +1. We value understandability more than accuracy. e.g. It's okay to describe a functor as a container. +1. Don't overuse jargon even if defined elsewhere in the document. +1. Link to terms defined else where in the document when you use them. +1. No big walls of text + +## Code conventions +Be consistent with other examples + +* Prefer arrow functions +* Parenthesis around function arguments +* Put output values in comments +* Use semi-colons +* Keep it short and simple + +This styleguide is a WIP too! Send PRs :)