STYLE-GUIDE.md

شیوه‌ نگارش

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

افزودن تگ اضافی

.هیچ تگی یا اضافاتی مثل استایل و دایرکشن نباید به سند اصلی اضافه شود تنها وظفه ما تغییر محتوای انگلیسی به فارسی است.

موارد داخل تگ‌های خاص و بک تیک (`) - (``) - (```)

موارد داخل تگ‌های خاص مانند Sandpack و غیره اصلا ترجمه نخواهد نشد.

حفظ شماره خط

تا جایی که امکان دارد شماره خط را راعایت کنیم. برای مثال پاراگرافی از خط ۹۰ الی ۹۵ می‌باشد. و پاراگراف بعدی از خط ۱۰۰ شروع می‌شود. اگر ترجمه ما بین خط ۹۰ الی ۹۳ قرار گرفت پاراگراف بعدی از خط ۹۸ شروع نخواهد شد بلکه همان خط ۱۰۰ باقی می‌ماند. این نکته اصلا اجباری نیست و صرفا جهت تمیز تر بودن و راحتی بررسی ترجمه گفته شده است.

بررسی اولیه پروژه قبل از ایجاد PR

همیشه قبل ایجاد پی‌آر ابتدا پروژه را در محیط لوکال خود ران کنید و از نداشتن ارور‌های جانبی مطمین شوید به عبارت دیگر صفحه ای که ترجمه کردید باید رد سیستم شما روی پروت ۳۰۰۰ بدون ارور اجرا شود.

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

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

## Try React {#try-react}

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

✅ صحیح:

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

❌ غلط:

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

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

متن در کد

فقط کامنت‌های یک کد را ترجمه کنید. از ترجمه دیگر بخش‌های کد بپرهیزید.

مثال:

// Example
const element = <h1>Hello, world</h1>;
ReactDOM.render(element, document.getElementById('root'));

✅ صحیح:

// مثال
const element = <h1>Hello, world</h1>;
ReactDOM.render(element, document.getElementById('root'));

❌ غلط:

// مثال
const element = <h1>سلام، دنیا</h1>;
ReactDOM.render(element, document.getElementById('root'));

❌ غلط:

// مثال
const element = <h1>سلام، دنیا</h1>;
// "root" به شناسه یک تگ اشاره دارد
// نباید آن را ترجمه کرد!
ReactDOM.render(element, document.getElementById('ریشه'));

❌ کاملا غلط:

// مثال
const eleman = <h1>سلام، دنیا</h1>;
ReactDOM.render(eleman, sanad.yaftanElemeanBaId('ریشه'));

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

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

مثال:

A stateful component inherits Component class.

✅ صحیح:

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

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

زبان فارسی

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

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