Skip to content

Commit c192168

Browse files
committedJul 5, 2018
chore: Add development setup section to the contributing docs.
1 parent 83ab391 commit c192168

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed
 

‎CONTRIBUTING.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,50 @@
22

33
Pull requests of any kind are welcome from the community, and if you're reading this I am really happy that you have decided to contribute. You rock! When contributing to this repository, please first discuss the change you wish to make via a GitHub issue with the owners of this repository before making a change.
44

5-
Please note we have a [Code of Conduct][url-code-of-conduct], please follow it in all your interactions with the project.
5+
Please note we have a [Code of Conduct][url-code-of-conduct], please follow it in all of your interactions with this project.
6+
7+
## Development Setup
8+
9+
**Installation:**
10+
11+
1. Clone the project `git clone git@github.com:matt-d-rat/react-middle-truncate.git`
12+
2. Install npm dependencies `npm install`
13+
14+
**Running the demo app:**
15+
16+
```
17+
npm start
18+
```
19+
20+
***Running Eslint***
21+
22+
```
23+
npm run check
24+
```
25+
26+
**Running the tests:**
27+
28+
_Mocha_
29+
30+
```
31+
npm run test
32+
```
33+
34+
```
35+
npm run test:watch
36+
```
37+
38+
_Karma (in-browser)_
39+
40+
```
41+
npm run test:karma
42+
```
43+
44+
_Test coverage_
45+
46+
```
47+
npm run cover
48+
```
649

750
## Pull Request Process
851

0 commit comments

Comments
 (0)
Please sign in to comment.