Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 1.42 KB
Raw

Contributing to NectarJS

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

We use GitHub to sync code to and from our internal repository. We'll use GitHub to track issues and feature requests, as well as accept pull requests.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

Contributor License Agreement ("CLA")

In order to accept your pull request, you will be asked to accept our CLA during the process.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Coding Style

  • 80 character line length
  • Run npm run lint to conform to our lint rules

License

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