-
Notifications
You must be signed in to change notification settings - Fork 47.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/15-stable' into 15-dev
- Loading branch information
Showing
55 changed files
with
1,611 additions
and
735 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,5 @@ | ||
| # Contributing to React | ||
|
|
||
| React is one of Facebook's first open source projects that is both under very active development and is also being used to ship code to everybody on [facebook.com](https://www.facebook.com). We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have. | ||
| Want to contribute to React? There are a few things you need to know. | ||
|
|
||
| ## [Code of Conduct](https://code.facebook.com/codeofconduct) | ||
|
|
||
| Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated. | ||
|
|
||
| ## Our Development Process | ||
|
|
||
| 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. | ||
|
|
||
| ### `master` is unsafe | ||
|
|
||
| We will do our best to keep `master` in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with. We will do our best to communicate these changes and always version appropriately so you can lock into a specific version if need be. | ||
|
|
||
| ### Test Suite | ||
|
|
||
| Use `grunt test` to run the full test suite with PhantomJS. | ||
|
|
||
| This command is just a facade to [Jest](https://facebook.github.io/jest/). You may optionally run `npm install -g jest-cli` and use Jest commands directly to have more control over how tests are executed. | ||
|
|
||
| For example, `jest --watch` lets you automatically run the test suite on every file change. | ||
|
|
||
| You can also run a subset of tests by passing a prefix to `jest`. For instance, `jest ReactDOMSVG` will only run tests in the files that start with `ReactDOMSVG`, such as `ReactDOMSVG-test.js`. | ||
|
|
||
| When you know which tests you want to run, you can achieve a fast feedback loop by using these two features together. For example, `jest ReactDOMSVG --watch` will re-run only the matching tests on every change. | ||
|
|
||
| Just make sure to run the whole test suite before submitting a pull request! | ||
|
|
||
| ### Pull Requests | ||
|
|
||
| **Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) | ||
|
|
||
| You may also be interested in watching [this short video](https://www.youtube.com/watch?v=wUpPsEcGsg8) (26 mins) which gives an introduction on how to contribute to the React JS project. | ||
|
|
||
| The core team will be monitoring for pull requests. When we get one, we'll run some Facebook-specific integration tests on it first. From here, we'll need to get another person to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process. | ||
|
|
||
| *Before* submitting a pull request, please make sure the following is done… | ||
|
|
||
| 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 (`grunt test`). | ||
| 5. Make sure your code lints (`grunt lint`) - we've done our best to make sure these rules match our internal linting guidelines. | ||
| 6. If you haven't already, complete the 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, so if you've done this for another Facebook open source project, you're good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username. | ||
|
|
||
| [Complete your CLA here.](https://code.facebook.com/cla) | ||
|
|
||
| ## Bugs | ||
|
|
||
| ### Where to Find Known Issues | ||
|
|
||
| We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist. | ||
|
|
||
| ### Reporting New Issues | ||
|
|
||
| The best way to get your bug fixed is to provide a reduced test case. jsFiddle, jsBin, and other sites provide a way to give live examples. Those are especially helpful though may not work for `JSX`-based code. | ||
|
|
||
| ### Security Bugs | ||
|
|
||
| Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. With that in mind, please do not file public issues; go through the process outlined on that page. | ||
|
|
||
| ## How to Get in Touch | ||
|
|
||
| * IRC - [#reactjs on freenode](https://webchat.freenode.net/?channels=reactjs) | ||
| * Discussion forum - [discuss.reactjs.org](https://discuss.reactjs.org/) | ||
|
|
||
| ## Meeting Notes | ||
|
|
||
| React team meets once a week to discuss the development of React, future plans, and priorities. | ||
| You can find the meeting notes in a [dedicated repository](https://github.com/reactjs/core-notes/). | ||
|
|
||
| ## 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: `grunt 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](https://github.com/airbnb/javascript) will guide you in the right direction. | ||
|
|
||
| ### Code Conventions | ||
|
|
||
| * Use semicolons `;` | ||
| * Commas last `,` | ||
| * 2 spaces for indentation (no tabs) | ||
| * Prefer `'` over `"` | ||
| * `'use strict';` | ||
| * 80 character line length | ||
| * Write "attractive" code | ||
| * Do not use the optional parameters of `setTimeout` and `setInterval` | ||
|
|
||
| ### Documentation | ||
|
|
||
| * Do not wrap lines at 80 characters | ||
|
|
||
| ## License | ||
|
|
||
| By contributing to React, you agree that your contributions will be licensed under its BSD license. | ||
| We wrote a **[contribution guide](https://facebook.github.io/react/contributing/how-to-contribute.html)** to help you get started. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,12 +35,12 @@ The fastest way to get started is to serve JavaScript from a CDN. We're using [u | |
|
|
||
| ```html | ||
| <!-- The core React library --> | ||
| <script src="https://unpkg.com/[email protected].1/dist/react.js"></script> | ||
| <script src="https://unpkg.com/[email protected].2/dist/react.js"></script> | ||
| <!-- The ReactDOM Library --> | ||
| <script src="https://unpkg.com/[email protected].1/dist/react-dom.js"></script> | ||
| <script src="https://unpkg.com/[email protected].2/dist/react-dom.js"></script> | ||
| ``` | ||
|
|
||
| We've also built a [starter kit](https://facebook.github.io/react/downloads/react-15.3.1.zip) which might be useful if this is your first time using React. It includes a webpage with an example of using React with live code. | ||
| We've also built a [starter kit](https://facebook.github.io/react/downloads/react-15.3.2.zip) which might be useful if this is your first time using React. It includes a webpage with an example of using React with live code. | ||
|
|
||
| If you'd like to use [bower](http://bower.io), it's as easy as: | ||
|
|
||
|
|
@@ -54,50 +54,17 @@ And it's just as easy with [npm](http://npmjs.com): | |
| npm i --save react | ||
| ``` | ||
|
|
||
| ## Contribute | ||
| ## Contributing | ||
|
|
||
| The main purpose of this repository is to continue to evolve React core, making it faster and easier to use. If you're interested in helping with that, then keep reading. If you're not interested in helping right now that's ok too. :) Any feedback you have about using React would be greatly appreciated. | ||
| The main purpose of this repository is to continue to evolve React core, making it faster and easier to use. If you're interested in helping with that, check out our [contribution guide](https://facebook.github.io/react/contributing/how-to-contribute.html). | ||
|
|
||
| ### Building Your Copy of React | ||
| ### [Code of Conduct](https://code.facebook.com/codeofconduct) | ||
|
|
||
| The process to build `react.js` is built entirely on top of node.js, using many libraries you may already be familiar with. | ||
|
|
||
| #### Prerequisites | ||
|
|
||
| * You have `node` installed at v4.0.0+ and `npm` at v2.0.0+. | ||
| * You have `gcc` installed or are comfortable installing a compiler if needed. Some of our `npm` dependencies may require a compliation step. On OS X, the Xcode Command Line Tools will cover this. On Ubuntu, `apt-get install build-essential` will install the required packages. Similar commands should work on other Linux distros. Windows will require some additional steps, see the [`node-gyp` installation instructions](https://github.com/nodejs/node-gyp#installation) for details. | ||
| * You are familiar with `npm` and know whether or not you need to use `sudo` when installing packages globally. | ||
| * You are familiar with `git`. | ||
|
|
||
| #### Build | ||
|
|
||
| Once you have the repository cloned, building a copy of `react.js` is really easy. | ||
|
|
||
| ```sh | ||
| # grunt-cli is needed by grunt; you might have this installed already | ||
| npm install -g grunt-cli | ||
| npm install | ||
| grunt build | ||
| ``` | ||
|
|
||
| At this point, you should now have a `build/` directory populated with everything you need to use React. The examples should all work. | ||
|
|
||
| ### Grunt | ||
|
|
||
| We use grunt to automate many tasks. Run `grunt -h` to see a mostly complete listing. The important ones to know: | ||
|
|
||
| ```sh | ||
| # Build and run tests with PhantomJS | ||
| grunt test | ||
| # Lint the code with ESLint | ||
| grunt lint | ||
| # Wipe out build directory | ||
| grunt clean | ||
| ``` | ||
| Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated. | ||
|
|
||
| ### Good First Bug | ||
| To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first bugs](https://github.com/facebook/react/labels/good%20first%20bug) that contain bugs which are fairly easy to fix. This is a great place to get started. | ||
|
|
||
| To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first bugs](https://github.com/facebook/react/labels/good%20first%20bug) that contain bugs which are fairly easy to fix. This is a great place to get started. | ||
|
|
||
| ### License | ||
|
|
||
|
|
@@ -107,9 +74,5 @@ React documentation is [Creative Commons licensed](./LICENSE-docs). | |
|
|
||
| Examples provided in this repository and in the documentation are [separately licensed](./LICENSE-examples). | ||
|
|
||
| ### More… | ||
|
|
||
| There's only so much we can cram in here. To read more about the community and guidelines for submitting pull requests, please read the [Contributing document](CONTRIBUTING.md). | ||
|
|
||
| ## Troubleshooting | ||
| See the [Troubleshooting Guide](https://github.com/facebook/react/wiki/Troubleshooting) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,8 @@ | ||
| - title: Contributing | ||
| items: | ||
| - id: how-to-contribute | ||
| title: How to Contribute | ||
| - id: codebase-overview | ||
| title: Codebase Overview | ||
| - id: design-principles | ||
| title: Design Principles |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.