Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (44 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

74 lines (44 loc) · 3.2 KB

Contributing

Pull requests are very welcome, but should be within the scope of the project, and follow the repository's code conventions. Before submitting a pull request, it's always good to file an issue, so we can discuss the details of the PR.

Found an issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue after going through this steps:

  1. Ensure you've replicated the issue against master. There is a chance the issue may have already been fixed.

  2. Search for any similar issues (both opened and closed). There is a chance someone may have reported it already.

  3. Provide a demo of the bug isolated in a jsfiddle/jsbin. Sometimes this is not a possibility, in which case provide a detailed description along with any code snippets that would help in triaging the issue. If we cannot reproduce it, we will close it.

  4. The best way to demonstrate a bug is to build a failing test. This is not required, however, it will generally speed up the development process.

Want a feature?

You can request a new feature by submitting an issue . If you would like to implement a new feature then consider what kind of change it is:

Major Changes that you wish to contribute to the project should be discussed first on our dev mailing list or IRC so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. Small Changes can be crafted and submitted to the GitHub Repository as a Pull Request.

Please see the Pull Requests below.

Pull Requests

  1. Fork the repository and create your branch from master.

  2. Ensure that all tests are passing prior to submitting.

  3. If you are adding new functionality, or fixing a bug, provide test coverage.

  4. Ensure the test suite passes

  5. Make sure your code lints - we've done our best to make sure these rules match our internal linting guidelines.

  6. If you've changed APIs, update the documentation.

  7. Follow syntax guidelines detailed below.

  8. Push the changes to your fork and submit a pull request. If this resolves any issues, please mark in the body resolve #ID within the body of your pull request. This allows for github to automatically close the related issue once the pull request is merged.

  9. Last step, submit the pull request!

Style Guide

Our linter will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running: npm run lint

However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at Airbnb's Style Guide will guide you in the right direction.

Code Conventions

  • Use semicolons ;
  • 2 spaces for indentation (no tabs)
  • Prefer ' over "
  • 80 character line length
  • Write "attractive" code
  • Do not use the optional parameters of setTimeout and setInterval
  • Documentation
  • Comments
  • Unit tests

Documentation

  • Do not wrap lines at 80 characters

License

By contributing to this project, you agree that your contributions will be licensed under its MIT license.