Skip to content

Commit 529a8da

Browse files
authored
Merge pull request #29 from udaypydi/doc/add-contribution-doc
contributing md added
2 parents 3fc714f + ad71d88 commit 529a8da

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to React Simple Boilerplate
2+
3+
Install the latest [npm](https://docs.npmjs.com/).
4+
5+
Fork the respository, then clone it
6+
```
7+
$ git@github.com:udaypydi/react-simple-boilerplate.git && cd react-simple-boilerplate
8+
$ yarn
9+
```
10+
11+
## Commands
12+
13+
Run unit tests
14+
15+
```
16+
# run test cases
17+
npm run test
18+
19+
# watch mode
20+
21+
npm run test:watch
22+
```
23+
24+
### Linting
25+
```
26+
npm run lint
27+
```
28+
It's also a good idea to add an eslint plugin in your editor.
29+
30+
To fix lint errors from the command line:
31+
```
32+
npm run lint
33+
```
34+
35+
## Submitting Pull Requests
36+
This project follows [GitHub's standard forking model.](https://guides.github.com/activities/forking/). Please fork the project to submit pull requests.

0 commit comments

Comments
 (0)