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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ The documentation is divided into sections to cater to different learning styles
20
20
21
21
**[Learn React](https://beta.reactjs.org/learn)** is designed to introduce fundamental concepts in a step-by-step way. Each individual article in Learn React 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 Learn React 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). Learn React also serves as a reference manual for React concepts, so it is important to be very strict about their definitions and relationships between them.
22
22
23
-
**[API Reference](https://reactjs.org/reference)** is organized by APIs rather than concepts. It is intended to be exhaustive. Any corner cases or recommendations that were skipped for brevity in Learn React should be mentioned in the reference documentation for the corresponding APIs.
23
+
**[API Reference](https://reactjs.org/apis/react)** is organized by APIs rather than concepts. It is intended to be exhaustive. Any corner cases or recommendations that were skipped for brevity in Learn React should be mentioned in the reference documentation for the corresponding APIs.
Copy file name to clipboardExpand all lines: README.md
+66-1Lines changed: 66 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,71 @@
1
1
# reactjs.org
2
2
3
-
This repo contains the source code fo documentation at [reactunity.github.io](https://reactunity.github.io/).
3
+
This repo contains the source code and documentation powering [beta.reactjs.org](https://beta.reactjs.org/).
4
+
5
+
6
+
## Getting started
7
+
8
+
### Prerequisites
9
+
10
+
1. Git
11
+
1. Node: any 12.x version starting with v12.0.0 or greater
12
+
1. Yarn: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/)
13
+
1. A fork of the repo (for any contributions)
14
+
1. A clone of the [reactjs.org repo](https://github.com/reactjs/reactjs.org) on your local machine
15
+
16
+
### Installation
17
+
18
+
`yarn` to install the website's npm dependencies
19
+
20
+
### Running locally
21
+
22
+
1. Make sure you're in the `beta` folder
23
+
1.`yarn dev` to start the development server (powered by [Next.js](https://nextjs.org/))
24
+
1.`open http://localhost:3000` to open the site in your favorite browser
25
+
26
+
## Contributing
27
+
28
+
### Guidelines
29
+
30
+
The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the [contributing guidelines](https://github.com/reactjs/reactjs.org/blob/main/CONTRIBUTING.md#guidelines-for-text) for the appropriate sections.
31
+
32
+
### Create a branch
33
+
34
+
1.`git checkout main` from any folder in your local `reactjs.org` repository
35
+
1.`git pull origin main` to ensure you have the latest main code
36
+
1.`git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch
37
+
38
+
### Make the change
39
+
40
+
1. Follow the ["Running locally"](#running-locally) instructions
41
+
1. Save the files and check in the browser
42
+
1. Changes to React components in `src` will hot-reload
43
+
1. Changes to markdown files in `content` will hot-reload
44
+
1. If working with plugins, you may need to remove the `.cache` directory and restart the server
45
+
46
+
### Test the change
47
+
48
+
1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
49
+
2. Run `yarn check-all` from the `beta` folder. (This will run Prettier, ESLint and validate types.)
50
+
51
+
### Push it
52
+
53
+
1.`git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fix header logo on Android`) to stage and commit your changes
54
+
1.`git push my-fork-name the-name-of-my-branch`
55
+
1. Go to the [reactjs.org repo](https://github.com/reactjs/reactjs.org) and you should see recently pushed branches.
56
+
1. Follow GitHub's instructions.
57
+
1. If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub.
58
+
59
+
## Translation
60
+
61
+
If you are interested in translating `reactjs.org`, please see the current translation efforts at [translations.reactjs.org](https://translations.reactjs.org/).
62
+
63
+
64
+
If your language does not have a translation and you would like to create one, please follow the instructions at [reactjs.org Translations](https://github.com/reactjs/reactjs.org-translation#translating-reactjsorg).
0 commit comments