From 680414e4d97d63a5e39d5f53bef6bf66ed39f9d1 Mon Sep 17 00:00:00 2001 From: Soroush Torkzadeh Date: Sun, 10 Feb 2019 23:00:50 +0330 Subject: [PATCH 1/2] Add STYLE-GUID.md --- STYLE-GUIDE.md | 109 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 STYLE-GUIDE.md diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md new file mode 100644 index 000000000..debc8b44f --- /dev/null +++ b/STYLE-GUIDE.md @@ -0,0 +1,109 @@ +

شیوه‌ نگارش

+ +

+برای حفظ یکپارچگی ترجمه در تمام صفحات و همچنین میان سایر زبان‌ها، لطفا قوانین زیر را مدنظر داشته‌باشید. +

+ +

آی‌دی عنوان‌ها

+ +

هر عنوانی یک آی‌دی منحصربه‌فرد دارد، مانند زیر:

+ +```md +## Try React {#try-react} +``` +

از ترجمه آی‌دی‌ها بپرهیزید! از آن‌ها برای هدایت به بخش‌های مختلف یک صفحه استفاده می‌شود. به خصوص اگر کاربر از یک لینک خارجی به یک بخش مورد نظر از صفحه هدایت شده‌باشد، این قابلیت از کار خواهد افتاد. برای مثال:

+ +```md +See the [beginning section](/getting-started#try-react) for more information. +``` + +

✅ صحیح:

+ +```md +## ری‌اکت را امتحان کنید {#try-react} +``` + +

❌ غلط:

+ +```md +## ری‌اکت را امتحان کنید {#react-ra-emtehan-konid} +``` +

ترجمه باعث از کار افتادن لینک بالا شده‌است.

+ + +

متن در کد

+

+فقط کامنت‌های یک کد را ترجمه کنید. شاید در بعضی موارد نیاز به ترجمه string باشد، اما نسبت به مواردی که ممکن است در منطق کد تغییر ایجاد کند آگاه باشید! +

+ +

مثال:

+ +```js +// Example +const element =

Hello, world

; +ReactDOM.render(element, document.getElementById('root')); +``` + +

✅ صحیح:

+ +```js +// مثال +const element =

Hello, world

; +ReactDOM.render(element, document.getElementById('root')); +``` + +

✅ صحیح:

+ +```js +// مثال +const element =

سلام، دنیا

; +ReactDOM.render(element, document.getElementById('root')); +``` + +

❌ غلط:

+ +```js +// مثال +const element =

سلام، دنیا

; +// "root" به آی‌دی یک تگ اشاره دارد +// نباید آن را ترجمه کرد! +ReactDOM.render(element, document.getElementById('ریشه')); +``` + +

❌ کاملا غلط:

+ +```js +// مثال +const eleman =

سلام، دنیا

; +ReactDOM.render(eleman, sanad.yaftanElemeanBaId('ریشه')); + +``` +

لینک‌های خارجی

+

+اگر یک لینک خارجی به یک مقاله از منابعی مانند شبکه توسعه‌دهنگان موزیلا (MDN) و ویکی‌پدیا (Wikipedia) ارجاع داده‌ شده‌است، در صورتی که نسخه فارسی آن مقاله موجود و از کیفیت مناسبی برخوردار است، به نسخه فارسی ارجاع داده‌شود. +

+ +

مثال:

+ +

+A stateful component inherits Component class. +

+ + + +

✅ صحیح:

+

+یک کامپوننت دارای state از کلاس Component ارث می‌برد. +

+
+

+برای لینک‌هایی که معادل فارسی ندارند مثل Stack Overflow و ویدیو‌های YouTube، از همان لینک انگلیسی استفاده‌شود. +

+ +

زبان فارسی

+

+هدف تمام مشارکت‌کنندگان تولید محتوای فارسی با بهترین کیفیت ممکن است تا به منبعی قابل استفاده برای همگان تبدیل شود. قطعا دستیابی به این هدف بدون رعایت شیوه‌ نگارش استاندارد فارسی میسر نخواهد‌شد. اگر نیاز به یک یادآوری داشتید، مقاله شیوه‌نامۀ «ویراستاران» برای نگارش در وب منبع مناسبی است. +

+

+اگر فکر می‌کنید چیزی فراموش شده‌است یا نیاز به تصحیح دارد، حتما نظر خود را با ما درمیان بگذارید. +

\ No newline at end of file From 4050dec6617153d92a54881b0ee733ae8d0ca562 Mon Sep 17 00:00:00 2001 From: Soroush Torkzadeh Date: Mon, 11 Feb 2019 12:45:59 +0330 Subject: [PATCH 2/2] Fix STYLE-GUIDE.md - Fix ID translation - Just translate comments of a code block and leave the other parts --- STYLE-GUIDE.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index debc8b44f..81cf2ed52 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -4,18 +4,15 @@ برای حفظ یکپارچگی ترجمه در تمام صفحات و همچنین میان سایر زبان‌ها، لطفا قوانین زیر را مدنظر داشته‌باشید.

-

آی‌دی عنوان‌ها

+

شناسه عنوان‌ها

-

هر عنوانی یک آی‌دی منحصربه‌فرد دارد، مانند زیر:

+

هر عنوانی یک شناسه منحصربه‌فرد دارد، مانند زیر:

```md ## Try React {#try-react} ``` -

از ترجمه آی‌دی‌ها بپرهیزید! از آن‌ها برای هدایت به بخش‌های مختلف یک صفحه استفاده می‌شود. به خصوص اگر کاربر از یک لینک خارجی به یک بخش مورد نظر از صفحه هدایت شده‌باشد، این قابلیت از کار خواهد افتاد. برای مثال:

+

از ترجمه شناسه‌ها بپرهیزید! از آن‌ها برای هدایت به بخش‌های مختلف یک صفحه استفاده می‌شود. به خصوص اگر کاربر از یک لینک خارجی به یک بخش مورد نظر از صفحه هدایت شده‌باشد، این قابلیت از کار خواهد افتاد.

-```md -See the [beginning section](/getting-started#try-react) for more information. -```

✅ صحیح:

@@ -33,7 +30,7 @@ See the [beginning section](/getting-started#try-react) for more information.

متن در کد

-فقط کامنت‌های یک کد را ترجمه کنید. شاید در بعضی موارد نیاز به ترجمه string باشد، اما نسبت به مواردی که ممکن است در منطق کد تغییر ایجاد کند آگاه باشید! +فقط کامنت‌های یک کد را ترجمه کنید. از ترجمه دیگر بخش‌های کد بپرهیزید.

مثال:

@@ -52,7 +49,7 @@ const element =

Hello, world

; ReactDOM.render(element, document.getElementById('root')); ``` -

✅ صحیح:

+

❌ غلط:

```js // مثال @@ -65,7 +62,7 @@ ReactDOM.render(element, document.getElementById('root')); ```js // مثال const element =

سلام، دنیا

; -// "root" به آی‌دی یک تگ اشاره دارد +// "root" به شناسه یک تگ اشاره دارد // نباید آن را ترجمه کرد! ReactDOM.render(element, document.getElementById('ریشه')); ```