diff --git a/README.md b/README.md index ed0651b9f..2aa24eb71 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,114 @@ -# reactjs.org - -This repo contains the source code and documentation powering [reactjs.org](https://reactjs.org/). - -## Getting started - -### Prerequisites - -1. Git -1. Node: any 8.x version starting with 8.4.0 or greater -1. Yarn: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/) -1. A fork of the repo (for any contributions) -1. A clone of the [reactjs.org repo](https://github.com/reactjs/reactjs.org) on your local machine - -### Installation - -1. `cd reactjs.org` to go into the project root -1. `yarn` to install the website's npm dependencies - -### Running locally - -1. `yarn dev` to start the hot-reloading development server (powered by [Gatsby](https://www.gatsbyjs.org)) -1. `open http://localhost:8000` to open the site in your favorite browser - -## Contributing - -### Guidelines - -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/master/CONTRIBUTING.md#guidelines-for-text) for the appropriate sections. - -### Create a branch - -1. `git checkout master` from any folder in your local `reactjs.org` repository -1. `git pull origin master` to ensure you have the latest main code -1. `git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch - -### Make the change - -1. Follow the "Running locally" instructions -1. Save the files and check in the browser - 1. Changes to React components in `src` will hot-reload - 1. Changes to markdown files in `content` will hot-reload - 1. If working with plugins, you may need to remove the `.cache` directory and restart the server - -### Test the change - -1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile. -1. Run `yarn check-all` from the project root. (This will run Prettier, ESLint, and Flow.) - -### Push it - -1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fixed header logo on Android`) to stage and commit your changes -1. `git push my-fork-name the-name-of-my-branch` -1. Go to the [reactjs.org repo](https://github.com/reactjs/reactjs.org) and you should see recently pushed branches. -1. Follow GitHub's instructions. -1. If possible, include screenshots of visual changes. A Netlify build will also be automatically created once you make your PR so other people can see your change. - -## Translation - -If you are interesting in translating `reactjs.org`, please see the current translation efforts at [isreacttranslatedyet.com](https://www.isreacttranslatedyet.com/). - - -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). - -## Troubleshooting - -- `yarn reset` to clear the local cache - -## License -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. +
+اگر این صفحه را مشاهده میکنید، احتمالا به ترجمه فارسی اسناد ریاکت (react) علاقهمند هستید. پس خوش آمدید! +
+ ++این مخزن کد (repo) با هدف توسعه اسناد ریاکت به زبان فارسی، از reactjs/reactjs.org انشعاب (fork) گرفتهاست و پیوسته با نسخه اصلی همگامسازی میشود. +
+ ++پیشرفت نسخه فارسی را از isreacttranslatedyet.com دنبال کنید. +
+ ++پیشنهاد میشود بهترتیب از لینکهای زیر شروع کنید: +
++حالا آدرس http://localhost:8000 را در مرورگر دلخواه خود باز کنید و تمام! +
+ ++اگر سوالی دارید با نگاهدارندگان تماس بگیرید یا یک موضوع (issue) جدید ثبت کنید! +
+ ++محتوایی که در reactjs.org قرار میگیرد، تخت مجوز CC-BY-4.0 منتشر میشود که جزئیات آن در LICENSE-DOCS.md آمدهاست. +
diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md new file mode 100644 index 000000000..81cf2ed52 --- /dev/null +++ b/STYLE-GUIDE.md @@ -0,0 +1,106 @@ ++برای حفظ یکپارچگی ترجمه در تمام صفحات و همچنین میان سایر زبانها، لطفا قوانین زیر را مدنظر داشتهباشید. +
+ +هر عنوانی یک شناسه منحصربهفرد دارد، مانند زیر:
+ +```md +## Try React {#try-react} +``` +از ترجمه شناسهها بپرهیزید! از آنها برای هدایت به بخشهای مختلف یک صفحه استفاده میشود. به خصوص اگر کاربر از یک لینک خارجی به یک بخش مورد نظر از صفحه هدایت شدهباشد، این قابلیت از کار خواهد افتاد.
+ + +✅ صحیح:
+ +```md +## ریاکت را امتحان کنید {#try-react} +``` + +❌ غلط:
+ +```md +## ریاکت را امتحان کنید {#react-ra-emtehan-konid} +``` +ترجمه باعث از کار افتادن لینک بالا شدهاست.
+ + ++فقط کامنتهای یک کد را ترجمه کنید. از ترجمه دیگر بخشهای کد بپرهیزید. +
+ +مثال:
+ +```js +// Example +const element =✅ صحیح:
+ +```js +// مثال +const element =❌ غلط:
+ +```js +// مثال +const element =❌ غلط:
+ +```js +// مثال +const element =❌ کاملا غلط:
+ +```js +// مثال +const eleman =+اگر یک لینک خارجی به یک مقاله از منابعی مانند شبکه توسعهدهنگان موزیلا (MDN) و ویکیپدیا (Wikipedia) ارجاع داده شدهاست، در صورتی که نسخه فارسی آن مقاله موجود و از کیفیت مناسبی برخوردار است، به نسخه فارسی ارجاع دادهشود. +
+ +مثال:
+ +
+A stateful component inherits Component class.
+
✅ صحیح:
+
+یک کامپوننت دارای state از کلاس Component ارث میبرد.
+
+برای لینکهایی که معادل فارسی ندارند مثل Stack Overflow و ویدیوهای YouTube، از همان لینک انگلیسی استفادهشود. +
+ ++هدف تمام مشارکتکنندگان تولید محتوای فارسی با بهترین کیفیت ممکن است تا به منبعی قابل استفاده برای همگان تبدیل شود. قطعا دستیابی به این هدف بدون رعایت شیوه نگارش استاندارد فارسی میسر نخواهدشد. اگر نیاز به یک یادآوری داشتید، مقاله شیوهنامۀ «ویراستاران» برای نگارش در وب منبع مناسبی است. +
++اگر فکر میکنید چیزی فراموش شدهاست یا نیاز به تصحیح دارد، حتما نظر خود را با ما درمیان بگذارید. +
\ No newline at end of file diff --git a/TRANSLATION.md b/TRANSLATION.md new file mode 100644 index 000000000..3b234e7af --- /dev/null +++ b/TRANSLATION.md @@ -0,0 +1,78 @@ ++فهرستی از واژههای فنی و اصطلاحات موردنیاز شما در اینجا آورده شدهاست. +
++ترجمه کلمهها و اصطلاحاتی که معادل مناسبی در جامعه نرمافزاری ما برای آنها تعریف شدهاست، در این جدول قرار گرفتهاست. +
++اگر عبارت موردنظر را در این لیست پیدا نکردید، شاید در بخش بعدی تعریف شدهباشد. +
+ +| + کلمه/عبارت + | ++ معادل پیشنهادی + | +
|---|---|
| + bug + | ++ خطا + | +
| + class + | ++ کلاس + | +
| + function + | ++ تابع + | +
+مواردی که هنوز معادل مناسبی برای آنها تعریف نشدهاست و ممکن است ترجمه آن در فهم مطلب اختلال ایجاد کند، در زیر آورده شدهاست. پیشنهاد میشود عین کلمه/عبارت انگلیسی در متن استفاده شود. +
+| + کلمه/عبارت + | +
|---|
| + props + | +
| + state + | +
+اگر فکر میکنید چیزی فراموش شدهاست یا نیاز به تصحیح دارد، حتما نظر خود را با ما درمیان بگذارید. +
\ No newline at end of file