mirror of
https://github.com/rjNemo/functional-programming-jargon
synced 2026-06-06 02:26:43 +00:00
Added the start of a styleguide
This commit is contained in:
parent
ed8b647d71
commit
6b77614ba2
1 changed files with 25 additions and 0 deletions
25
contributing.md
Normal file
25
contributing.md
Normal 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 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 :)
|
||||||
Loading…
Reference in a new issue