ruidy/functional-programming-jargon
1
0
Fork 0
mirror of https://github.com/rjNemo/functional-programming-jargon synced 2026-06-06 02:26:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #48 from jethrolarson/styleguide2

Browse source 
Styleguide2
This commit is contained in:
hemanth.hm 2016-06-10 10:36:32 +05:30 committed by GitHub
commit 91642be8fa
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
contributing.md Normal file
View file

@ -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 in the document when you use them in a definition.
1. Avoid 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 :)