Skip to content

Latest commit

 

History

History
executable file
·
26 lines (21 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
26 lines (21 loc) · 1.69 KB

How to Contribute

Report a problem or suggestion

Go to our issue tracker and check if your problem/suggestion is already reported. If not, create a new issue with a descriptive title and detail your suggestion or steps to reproduce the problem.

If you are reporting a bug, please point the environment where you find it, if you can, please confirm if the bug happens in other environments and list it.

Filter Issues

You can help answering issue questions; maturing or voting on feature suggestions; confirming bug reports and adding more information to then. You can help a lot locating the bug source and proposing test code to prevent regression bug.

Contribute to the code

If you know how to code, we welcome you to send fixes and new features, but in order to be efficient we ask you to follow the following procedure:

  • Fork this repo; By clicking on the fork button on Github
  • Clone your forked repo locally: git clone [project URL]
  • Run npm install to install all dependencies
  • Run npm start to start the app
  • Code your changes (if you want to implement many features do each one in a separated branch)
  • Write tests to ensure your feature works as expected and protect its behavior on future changes; Test it! Ensure you don't crash this project in Node.js or Browser environments;
  • Full test with npm test will also produce a coverage report.
  • Push to your forked repo;
  • Make your pull request.

For detail tutorial on how to contribute, The beginner's guide to contributing to a GitHub project