File tree Expand file tree Collapse file tree 1 file changed +41
-0
lines changed
Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing to SignalsJS
2+
3+ ## Setup
4+
5+ 1 - Clone your fork of the repository:
6+ ```
7+ $ git clone https://github.com/YOUR_USERNAME/SignalsJS.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+ - Always format your code using ` yarn run autoformat ` .
35+ - Please keep the test coverage at 100%. Write additional unit test if
36+ necessary
37+ - Please create an issue before sending a PR if your commit is going to change the
38+ public interface of SignalsJS or it includes significant architecture
39+ changes.
40+ - Feel free to ask for help from other members of the RobotlegsJS team via the
41+ chat or github issues.
You can’t perform that action at this time.
0 commit comments