forked from hemanth/functional-programming-jargon
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
jethro larson
committed
Jun 9, 2016
1 parent
ed8b647
commit 6b77614
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 :) |