Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

46 lines (37 loc) · 1.19 KB

Contributing to RobotlegsJS

Setup

1 - Clone your fork of the repository:

$ git clone https://github.com/YOUR_USERNAME/RobotlegsJS.git

2 - Install typings:

$ npm install -g typings

3 - Install type definitions:

$ typings install

4 - Install npm dependencies:

$ npm install

5 - Run build process

$ npm run build

Guidelines

  • Please try to combine multiple commits before pushing

  • 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 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 ./node_modules/.bin/tsfmt -r.

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

  • Please create an issue before sending a PR ff your it is going to change the public interface of RobotlegsJS or it includes significant architecture changes.

  • Feel free to ask for help from other members of the RobotlegsJS team via the chat or github issues.