|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the React Docs! |
| 4 | + |
| 5 | +## Code of Conduct |
| 6 | + |
| 7 | +Facebook has adopted a Code of Conduct that we expect project |
| 8 | +participants to adhere to. Please [read the full text](https://code.facebook.com/codeofconduct) |
| 9 | +so that you can understand what actions will and will not be tolerated. |
| 10 | + |
| 11 | +## Guidelines for Text |
| 12 | + |
| 13 | +**Different sections intentionally have different styles.** |
| 14 | + |
| 15 | +The documentation is divided into sections to cater to different learning styles and use cases. When editing an article, try to match the surrounding text in tone and style. When creating a new article, try to match the tone of the other articles in the same section. Learn about the motivation behind each section below. |
| 16 | + |
| 17 | +**[Tutorial](https://reactjs.org/tutorial/tutorial.html)** is relatively informal, and is designed for people who prefer a hands-on approach to learning, and can tolerate skipping theory in favor of practice. Its goal is to give the reader a feel for a typical React workflow rather than to explain fundamentals in detail. Here we focus on *what* to do and spend less time on *how* or *why* we did it. It is extremely important to do a lot of hand-holding and unambiguously describe every single change. It should be possible for a beginner to mechanically follow every instruction, and still get to a working tic-tac-toe game. |
| 18 | + |
| 19 | +**[Quick Start](https://reactjs.org/docs/hello-world.html)** is designed to introduce fundamental concepts in a step-by-step way. Each individual article in Quick Start builds on the knowledge from the previous ones, so make sure not to add any "cyclical dependencies" between them. It is important that the reader can start with the first article and work their way to the last Quick Start article without ever having to "look ahead" for a definition. This explains some ordering choices (e.g. that state is explained before events, or that "thinking in React" doesn't use refs). Quick Start also serves as a reference manual for React concepts, so it is important to be very strict about their definitions and relationships between them. This is, for example, why we introduce elements before components. Resist adding too much detail to Quick Start articles. They intentionally don't cover all corner cases, and focus on establishing firm foundations. |
| 20 | + |
| 21 | +**[Advanced Guides](https://reactjs.org/docs/jsx-in-depth.html)** are deep dives into topics that aren't essential for a beginner developer but that everyone bumps into sooner or later. They don't have a specific order, and target more experienced developers. If you have a set of recipes fitting a particular use case, and those recipes aren't opinionated (most React users would agree on them), this is the place to add them. |
| 22 | + |
| 23 | +**[Reference](https://reactjs.org/docs/react-api.html)** is organized by APIs rather than concepts. It is intended to be exhaustive. Any corner cases or recommendations that were skipped for brevity in Quick Start or Advanced Guides should be mentioned in the reference documentation for the corresponding APIs. |
| 24 | + |
| 25 | +**[Contributing](https://reactjs.org/docs/how-to-contribute.html)** should stay up-to-date and be friendly to relatively experienced developers. |
| 26 | + |
| 27 | +**[FAQ](https://reactjs.org/docs/faq-ajax.html)** has a more conversational tone than the other sections. Here, it's fine to include some content that's not primarily concerned with React, as long as React users are overwhelmingly interested in it (e.g. recommendations on directory structure). It's also okay to show more than a single way to do something in the FAQ, and briefly discuss the tradeoffs. The FAQ prioritizes unblocking people with a working solution over explaining concepts in detail, and can be more opinionated than the rest of the docs, even providing popular library recommendations. |
| 28 | + |
| 29 | +**Try to follow your own instructions.** |
| 30 | + |
| 31 | +When writing step-by-step instructions (e.g. how to install something), try to forget everything you know about the topic, and actually follow the instructions you wrote, a single step at time. Often you will discover that there is implicit knowledge that you forgot to mention, or that there are missing or out-of-order steps in the instructions. Bonus points for getting *somebody else* to follow the steps and watching what they struggle with. Often it would be something very simple that you have not anticipated. |
| 32 | + |
| 33 | +## Guidelines for Code Examples |
| 34 | + |
| 35 | +### Syntax |
| 36 | + |
| 37 | +**Prefer JSX to `createElement`.** |
| 38 | + |
| 39 | +Ignore this if you're specifically describing `createElement`. |
| 40 | + |
| 41 | +**Use `const` where possible, otherwise `let`. Don't use `var`.** |
| 42 | + |
| 43 | +Ignore this if you're specifically writing about ES5. |
| 44 | + |
| 45 | +**Don't use ES6 features when equivalent ES5 features have no downsides.** |
| 46 | + |
| 47 | +Remember that ES6 is still new to a lot of people. While we use it in many places (`const` / `let`, classes, arrow functions), if the equivalent ES5 code is just as straightforward and readable, consider using it. |
| 48 | + |
| 49 | +In particular, you should prefer named `function` declarations over `const myFunction = () => ...` arrows for top-level functions. However, you *should* use arrow functions where they provide a tangible improvement (such as preserving `this` context inside a component). Consider both sides of the tradeoff when deciding whether to use a new feature. |
| 50 | + |
| 51 | +**Don't use features that aren't standardized yet.** |
| 52 | + |
| 53 | +For example, **don't** write this: |
| 54 | + |
| 55 | +```js |
| 56 | +class MyComponent extends React.Component { |
| 57 | + state = {value: ''}; |
| 58 | + handleChange = (e) => { |
| 59 | + this.setState({value: e.target.value}); |
| 60 | + }; |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +Instead, **do** write this: |
| 65 | + |
| 66 | +```js |
| 67 | +class MyComponent extends React.Component { |
| 68 | + constructor(props) { |
| 69 | + super(props) |
| 70 | + this.handleChange = this.handleChange.bind(this); |
| 71 | + this.state = {value: ''}; |
| 72 | + } |
| 73 | + handleChange(e) { |
| 74 | + this.setState({value: e.target.value}); |
| 75 | + } |
| 76 | +} |
| 77 | +``` |
| 78 | + |
| 79 | +Ignore this rule if you're specifically describing an experimental proposal. Make sure to mention its experimental nature in the code and in the surrounding text. |
| 80 | + |
| 81 | +### Style |
| 82 | + |
| 83 | +- Use semicolons. |
| 84 | +- No space between function names and parens (`method() {}` not `method () {}`). |
| 85 | +- When in doubt, use the default style favored by [Prettier](https://prettier.io/playground/). |
| 86 | + |
| 87 | +### Highlighting |
| 88 | + |
| 89 | +Use `js` as the highlighting language in Markdown code blocks: |
| 90 | + |
| 91 | +```` |
| 92 | +```js |
| 93 | +// code |
| 94 | +``` |
| 95 | +```` |
| 96 | + |
| 97 | +Sometimes you'll see blocks with numbers. |
| 98 | +They tell the website to highlight specific lines. |
| 99 | + |
| 100 | +You can highlight a single line: |
| 101 | + |
| 102 | +```` |
| 103 | +```js{2} |
| 104 | +function hello() { |
| 105 | + // this line will get highlighted |
| 106 | +} |
| 107 | +``` |
| 108 | +```` |
| 109 | + |
| 110 | +A range of lines: |
| 111 | + |
| 112 | +```` |
| 113 | +```js{2-4} |
| 114 | +function hello() { |
| 115 | + // these lines |
| 116 | + // will get |
| 117 | + // highlighted |
| 118 | +} |
| 119 | +``` |
| 120 | +```` |
| 121 | + |
| 122 | +Or even multiple ranges: |
| 123 | + |
| 124 | +```` |
| 125 | +```js{2-4,6} |
| 126 | +function hello() { |
| 127 | + // these lines |
| 128 | + // will get |
| 129 | + // highlighted |
| 130 | + console.log('hello'); |
| 131 | + // also this one |
| 132 | + console.log('there'); |
| 133 | +} |
| 134 | +``` |
| 135 | +```` |
| 136 | + |
| 137 | +Be mindful that if you move some code in an example with highlighting, you also need to update the highlighting. |
| 138 | + |
| 139 | +Don't be afraid to often use highlighting! It is very valuable when you need to focus the reader's attention on a particular detail that's easy to miss. |
0 commit comments