File tree

3 files changed

+210
-385
lines changed

3 files changed

+210
-385
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1-
# Berkontribusi
1+
# Contributing
22

3-
Proyek ini berkembang seiring dengan berkembangnya konten dari
4-
[_Functional Programming Jargon_](https://.com/hemanth/functional-programming-jargon/)
5-
milik [hemanth](https://.com/hemanth/). Maka dari itu sebaiknya Anda
6-
berkontribusi langsung ke _repository_ tersebut. Akan tetapi, kontribusi dalam
7-
bentuk apapun ke _repository_ ini sangat dipersilakan.
3+
This project is a work in progress. Contributions are very welcome.
4+
5+
## Hard rules
6+
* Run `npm test` to lint the code examples. Your changes must pass.
7+
* If you add a new definition or reorder them run `npm run toc` to regenerate the table of contents.
8+
9+
That said, we'd like to maintain some consistency across the document.
10+
11+
## Style guide
12+
1. Every definition should include at least one JavaScript code example.
13+
1. Definitions should be written using the simplest language possible. Every word should tell.
14+
1. Target programmers that have no functional programming experience.
15+
1. We value understandability more than accuracy. e.g. It's okay to describe a functor as a container.
16+
1. Don't overuse jargon even if defined elsewhere in the document.
17+
1. Link to terms defined in the document when you use them in a definition.
18+
1. Avoid big walls of text
19+
20+
## Code conventions
21+
[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://.com/feross/standard)
22+
23+
* Be consistent with other examples
24+
* Prefer arrow functions
25+
* Parenthesis around function arguments
26+
* Put output values in comments
27+
* Keep it short and simple
28+
29+
This styleguide is a WIP too! Send PRs :)
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
{
2-
"name": "jargon-pemrograman-fungsional",
2+
"name": "functional-programming-jargons",
33
"version": "1.0.0",
4-
"description": "Jargon dari dunia pemrograman fungsional secara sederhana!",
4+
"description": "Jargon from the functional programming world in simple terms!",
55
"main": "index.js",
66
"scripts": {
77
"test": "eslint readme.md",
88
"toc": "roadmarks"
99
},
1010
"repository": {
1111
"type": "git",
12-
"url": "git+https://.com/wisn/jargon-pemrograman-fungsional.git"
12+
"url": "git+https://.com/hemanth/functional-programming-jargon.git"
1313
},
14-
"author": "wisn",
14+
"author": "hemanth",
1515
"license": "MIT",
1616
"bugs": {
17-
"url": "https://.com/wisn/jargon-pemrograman-fungsional/issues"
17+
"url": "https://.com/hemanth/functional-programming-jargon/issues"
1818
},
19-
"homepage": "https://.com/wisn/jargon-pemrograman-fungsional#readme",
19+
"homepage": "https://.com/hemanth/functional-programming-jargon#readme",
2020
"devDependencies": {
2121
"eslint": "^3.4.0",
2222
"eslint-config-standard": "^6.0.0",

0 commit comments

Comments
 (0)