Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

41 lines (33 loc) · 1.67 KB
Raw

Contributing to Nuclide

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

Our Development Process

Nuclide is currently developed in Facebook's internal repositories and then exported out to GitHub by a Facebook team member, however we invite you to submit pull requests as below.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master for core changes, or gh-pages for docs and website changes.
  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 by running scripts/dev/test.
  5. Make sure your JavaScript code lints by using Flow.
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.

Complete your CLA here: https://code.facebook.com/cla

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.

Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

Coding Style

  • Spaces for indentation rather than tabs - 2 for JavaScript, 4 for Python
  • 100 character line length

License

By contributing to Nuclide, you agree that your contributions will be licensed under the license outlined in the LICENSE file in the same directory as this file.