Skip to content

Commit a9076e6

Browse files
authored
Docs: Update contributing gude lines
1 parent 0ddded4 commit a9076e6

File tree

1 file changed

+8
-35
lines changed

1 file changed

+8
-35
lines changed

Contributing.md

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,7 @@ I love pull requests. And following this simple guidelines will make your pull r
1515

1616
## JavaScript code style
1717

18-
See [ESLint](.eslintrc) config files for more details.
19-
20-
- Tab indentation.
21-
- Single-quotes.
22-
- Semicolons.
23-
- No trailing whitespace.
24-
- Variables where needed.
25-
- Multiple variable statements.
26-
- Space after keywords and between arguments and operators.
27-
- Use === and !== over == and !=.
28-
- Return early.
29-
- Limit line lengths to 120 chars.
30-
- Prefer readability over religion.
31-
- Use ES6.
32-
33-
Example:
34-
35-
```js
36-
function foo(bar, fum) {
37-
if (!bar) {
38-
return;
39-
}
40-
41-
let hello = 'Hello';
42-
let ret = 0;
43-
for (let barIdx = 0; barIdx < bar.length; barIdx++) {
44-
if (bar[barIdx] === hello) {
45-
ret += fum(bar[barIdx]);
46-
}
47-
}
48-
49-
return ret;
50-
}
51-
```
18+
[See here](https://github.com/tamiadev/eslint-config-tamia#code-style-at-a-glance).
5219

5320

5421
## Other notes
@@ -68,7 +35,13 @@ Install dependencies:
6835
npm install
6936
```
7037

71-
Build / run tests:
38+
Run example style guide:
39+
40+
```bash
41+
npm start
42+
```
43+
44+
Run tests:
7245

7346
```bash
7447
npm test

0 commit comments

Comments
 (0)