Skip to content

Commit c923eb2

Browse files
committed
add contributing guidelines
1 parent da91bf4 commit c923eb2

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to RobotlegsJS-SignalCommandMap
2+
3+
## Setup
4+
5+
1 - Clone your fork of the repository:
6+
```
7+
$ git clone https://github.com/YOUR_USERNAME/RobotlegsJS-SignalCommandMap.git
8+
```
9+
10+
2 - Install npm dependencies using yarn:
11+
```
12+
$ yarn install
13+
```
14+
15+
3 - Run start process
16+
```
17+
$ yarn start
18+
```
19+
20+
4 - Run test process
21+
```
22+
$ yarn test
23+
```
24+
25+
## Guidelines
26+
27+
- Please try to [combine multiple commits before
28+
pushing](http://stackoverflow.com/questions/6934752/combining-multiple-commits-before-pushing-in-git).
29+
30+
- Please use `TDD` when fixing bugs. This means that you should write a unit
31+
test that fails because it reproduces the issue, then fix the issue and finally run
32+
the test to ensure that the issue has been resolved. This helps us to prevent
33+
fixed bugs from happening again in the future.
34+
35+
- Always format your code using `yarn run autoformat`.
36+
37+
- Please keep the test coverage at 100%. Write additional unit test if
38+
necessary.
39+
40+
- Please create an issue before sending a PR if your commit is going to change the
41+
public interface of the package or it includes significant architecture
42+
changes.
43+
44+
- Feel free to ask for help from other members of the RobotlegsJS team via the
45+
[gitter chat](https://gitter.im/RobotlegsJS/RobotlegsJS) or
46+
[github issues](https://github.com/RobotlegsJS/RobotlegsJS-SignalCommandMap/issues).

0 commit comments

Comments
 (0)