Skip to content
This repository has been archived by the owner on Jan 13, 2022. It is now read-only.

Commit

Permalink
update contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ehzhang committed Jul 8, 2015
1 parent a956db2 commit a85d654
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,32 @@ We want to make contributing to this project as easy and transparent as possible
Some of the core team will be working directly on GitHub. These changes will be public from the beginning. Other changesets will come via a bridge with Facebook's internal source control. This is a necessity as it allows engineers at Facebook outside of the core team to move fast and contribute from an environment they are comfortable in.

## Pull Requests
We actively welcome your pull requests.
1. Fork the repo and create your branch from `master`.

We actively welcome your pull requests - however, before you begin a pull request, please create an issue so we can determine whether or not the work that you are planning to do is either already being worked on or out of the scope of this project.

1. Fork the repo and create your branch from `master`.

2. If you've added code that should be tested, add tests (tests coming soon).
3. If you've changed APIs, update the documentation via `build_helpers/buildAPIDocs.sh`.
4. Ensure the test suite passes (coming soon).
5. Make sure your code lints (coming soon).

3. Ensure the test suite passes (coming soon).

4. Make sure your code lints (coming soon).

5. Do not commit anything to the `dist` folder.

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
## 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](https://www.facebook.com/whitehat/) 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
## Coding Style
* Use semicolons;
* Commas last,
* 2 spaces for indentation (no tabs)
Expand Down

0 comments on commit a85d654

Please sign in to comment.