Skip to content

Commit

Permalink
New translations guidelines.md (Persian)
Browse files Browse the repository at this point in the history
  • Loading branch information
TonSquare committed Dec 19, 2024
1 parent 80d9a15 commit b693cc8
Showing 1 changed file with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ما بسیار خوشحالیم که شما را در میان همکارانمان داریم! لطفاً راهنماهای زیر را مرور کنید تا مطمئن شوید آموزش شما سبک و کیفیت محتوای موجود در TON Docs را دنبال می‌کند.

مهم است که زمانی را برای آشنا شدن با ساختار آموزش و نحوه‌ی استفاده از تیترها صرف کنید. لطفاً پیش از ارسال آموزش خود، به برخی از آموزش‌های موجود ما و [درخواست‌های قبلی ادغام](https://github.com/ton-community/ton-docs/pulls?q=is%3Apr+is%3Aclosed) نگاهی بیندازید.
مهم است که زمانی را برای آشنا شدن با ساختار آموزش و نحوه‌ی استفاده از تیترها صرف کنید. لطفاً پیش از ارسال آموزش خود، به برخی از آموزش‌های موجود ما و [درخواست‌های قبلی کششی](https://github.com/ton-community/ton-docs/pulls?q=is%3Apr+is%3Aclosed) نگاهی بیندازید.

## فرآیند

Expand All @@ -16,7 +16,7 @@

1. برای شروع، مخزن [ton-docs](https://github.com/ton-community/ton-docs/) را در GitHub فورک کنید و سپس کلون کنید و یک شاخه جدید در مخزن محلی خود ایجاد کنید.
2. آموزش خود را با حفظ کیفیت و خوانایی بنویسید! به آموزش‌های موجود نگاهی بیندازید تا بدانید چه چیزی باید هدف شما باشد.
3. هنگامی که آماده ارسال آن برای بررسی هستید، از شاخه خود [درخواست ادغام باز کنید](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). ما مطلع خواهیم شد و فرآیند بررسی آغاز می‌شود:
3. هنگامی که آماده ارسال آن برای بررسی هستید، از شاخه خود [درخواست کششی باز کنید](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). ما مطلع خواهیم شد و فرآیند بررسی آغاز می‌شود:
1. **لطفاً تمام تلاش خود را برای ارسال فقط پیش‌نویس نهایی آموزش خود انجام دهید**. تعدادی اشتباه نوشتاری و اصلاحات گرامری قابل قبول است، اما اگر قبل از اینکه بتوانیم آموزش را منتشر کنیم، تغییرات مورد توجهی لازم باشد، درخواست تغییرات لازم و بررسی مجدد بسیار بیشتر طول خواهد کشید.
4. وقتی ارسال شما را بررسی کردیم و شما تمام تغییرات لازم را انجام دادید، درخواست را ادغام خواهیم کرد و آموزش شما را در مستندات TON منتشر خواهیم کرد. بلافاصله پس از آن با شما تماس خواهیم گرفت تا پرداخت شما را تنظیم کنیم!
5. پس از انتشار، به یاد داشته باشید که آموزش خود را در شبکه‌های اجتماعی **ترویج** کنید! تا زمانی که با ما همکاری کنید، [نگهدارندگان مستندات](/v3/contribute/maintainers) می‌توانند برای تقویت این تبلیغ کمک کنند.
Expand All @@ -25,7 +25,7 @@

1. مخزن **`ton-docs`** را ***فورک و کلون کنید***
2. آموزش خود را ***بنویسید و اصلاح کنید***
3. ***برای بررسی درخواست ادغام ارسال کنید***
3. ***برای بررسی درخواست کششی ارسال کنید***
4. ***هر گونه تغییر لازم را اعمال کنید***
5. آموزش ***ادغام و منتشر شده است***
6. آموزش خود را در رسانه‌های اجتماعی ***تبلیغ کنید***!
Expand All @@ -41,13 +41,13 @@
## نکات عمومی

- **محتوای موجود را کپی و پیست نکنید**. سرقت ادبی یک مشکل جدی است و تحمل نخواهد شد. اگر آموزش از محتوای موجود الهام گرفته شده است، به آن ارجاع دهید و لینک بدهید. هنگام لینک دادن به سایر آموزش‌ها/منابع، در صورت امکان از منابع TON Docs استفاده کنید.
- **هر گونه فیلم آموزشی یا محتوای ویدیویی** را با بارگذاری آن در Google Drive در PR بگنجانید.
- **هر گونه فیلم آموزشی یا محتوای ویدیویی** را با بارگذاری آن در Google Drive در درخواست کششی بگنجانید.
- **تأمین مالی حساب از فاست‌ها باید به وضوح توضیح داده شود**، از جمله اینکه کدام حساب تأمین مالی می‌شود، از کجا و چرا. فرض نکنید که یادگیرندگان می‌توانند این کار را به تنهایی انجام دهند!
- **نمونه خروجی‌ها را به صورت قطعات ترمینال در کد یا تصاویر نمایش دهید** تا به یادگیرندگان کمک کنید بدانند چه انتظاری داشته باشند. خروجی‌های طولانی را برش دهید.
- **از رویکرد مبتنی بر خطا استفاده کنید** که در آن عمداً با خطاها مواجه می‌شوید تا به یادگیرندگان نحوه رفع آن‌ها را آموزش دهید. به عنوان مثال، اگر نیاز دارید یک حساب را برای توانایی راه‌اندازی یک قرارداد هوشمند تأمین مالی کنید، ابتدا سعی کنید بدون تأمین مالی، قرارداد را راه‌اندازی کنید، خطایی که باز می‌گردد را مشاهده کنید، سپس خطا را اصلاح کنید (با تأمین مالی حساب) و دوباره امتحان کنید.
- **خطاهای احتمالی و عیب‌یابی را اضافه کنید**. البته، آموزش نباید هر خطای ممکن را لیست کند، اما باید تلاش کند تا مهم‌ترین یا معمول‌ترین آن‌ها را پیدا کند.
- برای سمت کلاینت **از React یا Vue استفاده کنید**.
- **قبل از ارسال PR، ابتدا خودتان کد را اجرا کنید** تا از خطاهای آشکار جلوگیری کنید و اطمینان حاصل کنید که آن‌طور که انتظار می‌رود کار می‌کند.
- **قبل از ارسال درخواست کششی، ابتدا خودتان کد را اجرا کنید** تا از خطاهای آشکار جلوگیری کنید و اطمینان حاصل کنید که آن‌طور که انتظار می‌رود کار می‌کند.
- **از افزودن پیوندهای خارجی/متقاطع به منابع مختلف بین آموزش‌ها خودداری کنید**. اگر آموزش شما طولانی‌ است، می‌توانیم درباره تبدیل آن به یک دوره طولانی‌تر یا مسیردار بحث کنیم.
- در صورت نیاز **عکس‌ها یا اسکرین‌شات‌ها** را برای توضیح فرآیندهای پیچیده ارائه دهید.
- تصاویر خود را به دایرکتوری `static` ریپازیتوری learn-tutorials آپلود کنید — **هرگز** از لینک‌های خارجی استفاده نکنید، زیرا این می‌تواند به خرابی تصاویر منجر شود.
Expand Down

0 comments on commit b693cc8

Please sign in to comment.