Skip to content

Commit

Permalink
add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagoschenkel committed Aug 11, 2017
1 parent d6d2177 commit 2a0c2d3
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing to RobotlegsJS-Macrobot

## Setup

1 - Clone your fork of the repository:
```
$ git clone https://github.com/YOUR_USERNAME/RobotlegsJS-Macrobot.git
```

2 - Install npm dependencies using yarn:
```
$ yarn install
```

3 - Run start process
```
$ yarn start
```

4 - Run test process
```
$ yarn test
```

## Guidelines

- Please try to [combine multiple commits before
pushing](http://stackoverflow.com/questions/6934752/combining-multiple-commits-before-pushing-in-git).

- Please use `TDD` when fixing bugs. This means that you should write a unit
test that fails because it reproduces the issue, then fix the issue and finally run
the test to ensure that the issue has been resolved. This helps us to prevent
fixed bugs from happening again in the future.

- Always format your code using `yarn run autoformat`.

- Please keep the test coverage at 100%. Write additional unit test if
necessary.

- Please create an issue before sending a PR if your commit is going to change the
public interface of the package or it includes significant architecture
changes.

- Feel free to ask for help from other members of the RobotlegsJS team via the
[gitter chat](https://gitter.im/RobotlegsJS/RobotlegsJS) or
[github issues](https://github.com/RobotlegsJS/RobotlegsJS-Macrobot/issues).

0 comments on commit 2a0c2d3

Please sign in to comment.