|
| 1 | +<<<<<<< HEAD |
1 | 2 | <h1 dir="rtl">نسخه فارسی <a href="https://reactjs.org/">reactjs.org</a></h1>
|
2 | 3 |
|
3 | 4 | <p dir="rtl">
|
@@ -140,3 +141,75 @@ yarn dev
|
140 | 141 | <p dir="rtl">
|
141 | 142 | محتوایی که در <a href="https://reactjs.org/">reactjs.org</a> قرار میگیرد، تخت مجوز CC-BY-4.0 منتشر میشود که جزئیات آن در <a href="https://github.com/open-source-explorer/reactjs.org/blob/master/LICENSE-DOCS.md">LICENSE-DOCS.md</a> آمدهاست.
|
142 | 143 | </p>
|
| 144 | +======= |
| 145 | +# reactjs.org |
| 146 | + |
| 147 | +This repo contains the source code and documentation powering [reactjs.org](https://reactjs.org/). |
| 148 | + |
| 149 | +## Getting started |
| 150 | + |
| 151 | +### Prerequisites |
| 152 | + |
| 153 | +1. Git |
| 154 | +1. Node: any 12.x version starting with v12.0.0 or greater |
| 155 | +1. Yarn: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/) |
| 156 | +1. A fork of the repo (for any contributions) |
| 157 | +1. A clone of the [reactjs.org repo](https://github.com/reactjs/reactjs.org) on your local machine |
| 158 | + |
| 159 | +### Installation |
| 160 | + |
| 161 | +1. `cd reactjs.org` to go into the project root |
| 162 | +1. `yarn` to install the website's npm dependencies |
| 163 | + |
| 164 | +### Running locally |
| 165 | + |
| 166 | +1. `yarn dev` to start the hot-reloading development server (powered by [Gatsby](https://www.gatsbyjs.org)) |
| 167 | +1. `open http://localhost:8000` to open the site in your favorite browser |
| 168 | + |
| 169 | +## Contributing |
| 170 | + |
| 171 | +### Guidelines |
| 172 | + |
| 173 | +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. |
| 174 | + |
| 175 | +### Create a branch |
| 176 | + |
| 177 | +1. `git checkout main` from any folder in your local `reactjs.org` repository |
| 178 | +1. `git pull origin main` to ensure you have the latest main code |
| 179 | +1. `git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch |
| 180 | + |
| 181 | +### Make the change |
| 182 | + |
| 183 | +1. Follow the ["Running locally"](#running-locally) instructions |
| 184 | +1. Save the files and check in the browser |
| 185 | + 1. Changes to React components in `src` will hot-reload |
| 186 | + 1. Changes to markdown files in `content` will hot-reload |
| 187 | + 1. If working with plugins, you may need to remove the `.cache` directory and restart the server |
| 188 | + |
| 189 | +### Test the change |
| 190 | + |
| 191 | +1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile. |
| 192 | +1. Run `yarn check-all` from the project root. (This will run Prettier, ESLint, and Flow.) |
| 193 | + |
| 194 | +### Push it |
| 195 | + |
| 196 | +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 |
| 197 | +1. `git push my-fork-name the-name-of-my-branch` |
| 198 | +1. Go to the [reactjs.org repo](https://github.com/reactjs/reactjs.org) and you should see recently pushed branches. |
| 199 | +1. Follow GitHub's instructions. |
| 200 | +1. If possible, include screenshots of visual changes. A [Netlify](https://www.netlify.com/) build will also be automatically created once you make your PR so other people can see your change. |
| 201 | + |
| 202 | +## Translation |
| 203 | + |
| 204 | +If you are interested in translating `reactjs.org`, please see the current translation efforts at [isreacttranslatedyet.com](https://www.isreacttranslatedyet.com/). |
| 205 | + |
| 206 | + |
| 207 | +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). |
| 208 | + |
| 209 | +## Troubleshooting |
| 210 | + |
| 211 | +- `yarn reset` to clear the local cache |
| 212 | + |
| 213 | +## License |
| 214 | +Content submitted to [reactjs.org](https://reactjs.org/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](https://github.com/open-source-explorer/reactjs.org/blob/master/LICENSE-DOCS.md) file. |
| 215 | +>>>>>>> 95e15d063b205007a92c52efb5311f76ad5a0b6c |
0 commit comments