You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit ee1bac9
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-34Lines changed: 2 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,41 +38,9 @@ Ignore this if you're specifically describing `createElement`.
38
38
39
39
Ignore this if you're specifically writing about ES5.
40
40
41
-
#### Don't use ES6 features when equivalent ES5 features have no downsides.
41
+
#### Prefer readable syntax.
42
42
43
-
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.
44
-
45
-
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.
46
-
47
-
#### Don't use features that aren't standardized yet.
48
-
49
-
For example, **don't** write this:
50
-
51
-
```js
52
-
classMyComponentextendsReact.Component {
53
-
state = {value:''};
54
-
handleChange= (e) => {
55
-
this.setState({value:e.target.value});
56
-
};
57
-
}
58
-
```
59
-
60
-
Instead, **do** write this:
61
-
62
-
```js
63
-
classMyComponentextendsReact.Component {
64
-
constructor(props) {
65
-
super(props);
66
-
this.handleChange=this.handleChange.bind(this);
67
-
this.state= {value:''};
68
-
}
69
-
handleChange(e) {
70
-
this.setState({value:e.target.value});
71
-
}
72
-
}
73
-
```
74
-
75
-
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.
43
+
Choose syntax that makes each example easier to follow. Prefer named `function` declarations over `const myFunction = () => ...` arrows for top-level functions. Use arrow functions when they make callbacks easier to read. In class components, arrow functions can also preserve the component's `this` value.
Copy file name to clipboardExpand all lines: README.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,15 @@ This repo contains the source code and documentation powering [react.dev](https:
7
7
### Prerequisites
8
8
9
9
1. Git
10
-
1. Node: any version starting with v16.8.0 or greater
11
-
1. Yarn: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/)
10
+
1. Node: v24 or greater
11
+
1. Yarn Classic: See [Yarn website for installation instructions](https://classic.yarnpkg.com/en/docs/install/)
12
12
1. A fork of the repo (for any contributions)
13
13
1. A clone of the [react.dev repo](https://github.com/reactjs/react.dev) on your local machine
14
14
15
15
### Installation
16
16
17
17
1.`cd react.dev` to go into the project root
18
+
2.`git remote add my-fork-name https://github.com/YOUR_USERNAME/react.dev.git` to add your fork as a remote. Replace `YOUR_USERNAME` with your GitHub username. You only need to do this once.
18
19
3.`yarn` to install the website's npm dependencies
19
20
20
21
### Running locally
@@ -39,8 +40,8 @@ The documentation is divided into several sections with a different tone and pur
39
40
1. Follow the ["Running locally"](#running-locally) instructions
40
41
1. Save the files and check in the browser
41
42
1. Changes to React components in `src` will hot-reload
42
-
1. Changes to markdown files in `content` will hot-reload
43
-
1. If working with plugins, you may need to remove the `.cache` directory and restart the server
43
+
1. Changes to markdown files in `src/content` will hot-reload
44
+
1. If working with plugins, you may need to remove the `node_modules/.cache/react-docs-mdx` directory and restart the server
44
45
45
46
### Test the change
46
47
@@ -57,7 +58,7 @@ The documentation is divided into several sections with a different tone and pur
57
58
58
59
## Translation
59
60
60
-
If you are interested in translating `react.dev`, please see the current translation efforts [here](https://github.com/reactjs/react.dev/issues/4135).
61
+
If you are interested in translating `react.dev`, please see the current translation efforts [here](https://react.dev/community/translations).
61
62
62
63
## License
63
64
Content submitted to [react.dev](https://react.dev/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](https://github.com/reactjs/react.dev/blob/main/LICENSE-DOCS.md) file.
0 commit comments