ترجمه مستندات فلاسک(Flask)

راهنمای مشارکت

نصب

روی دکمه Fork برای گرفتن یک انشعاب از این مخزن کلیک کنید
انشعاب مخزن را به صورت محلی شبیه سازی کنید ¹ (نام کاربری خود را با {username} جایگزین کنید):

$ git clone https://github.com/{username}/flask-docs-fa
$ cd flask-docs-fa
$ git remote add upstream https://github.com/flaskcwg/flask-docs-fa

یک محیط مجازی ایجاد کنید و ملزومات را نصب کنید

برای Linux/macOS:

$ python3 -m venv env
$ source env/bin/activate
$ python -m pip install --upgrade pip setuptools
$ pip install -r requirements/dev.txt
$ pip install -e .
$ pre-commit install

برای Windows:

> python -m venv env
> env\Scripts\activate
> python -m pip install --upgrade pip setuptools
> pip install -r .\requirements\dev.txt
> pip install -e .
> pre-commit install

نرم افزار های پیشنهادی برای ترجمه

همانطور که در زیر توضیح داده شده است، ترجمه ها با استفاده از فایل های .po انجام می شود. POEdit یک نرم افزار خوب برای اینکار است. ( نباید با POEditor اشتباه گرفته شود.

ترجمه

لطفا قبل از شروع ترجمه یک issue با نام ترجمه بخش درخواستی خودتان ایجاد کنید.

پس از آن که در issue درخواست ترجمه شما پذیرفته شد، یک شاخه جدید به صورت محلی ایجاد کنید (حتما نام شاخه را بروزرسانی کنید. , به عنوان مثال, translate-cli ):

ابزار های پیشنهادی ترجمه

شما میتونید از ابزار های زیر برای ترجمه استفاده کنید:

مترجم گوگل: Google Translate
مترجم ترگمان: Targoman

نکته لطفا در هنگام ارسال pr، ماشینی بودن یا نبودن ترجمه را ذکر کنید.

$ git fetch upstream
$ git checkout -b your-branch-name upstream/main

فایل های .po در دایرکتوری docs/locales/fa/LC_MESSAGES ترجمه کنید.

اگر از یک نرم افزار ترجمه استفاده میکنید نیازی نیست سینتکس نمونه های زیر را بررسی کنید.

نمونه‌ای از یکی از این فایل‌ها، از docs/.../index.po ، در زیر آورده شده است.

#: ../../index.rst:4
msgid "Welcome to Flask"
msgstr "<اینجا را با ترجمه پر کنید.>"

یک مورد دیگر msgid که یک متن چند خطی است و حاوی سینتکس² reStructuredText است:

#: ../../index.rst:11
msgid ""
"Welcome to Flask's documentation. Get started with :doc:`installation` "
"and then get an overview with the :doc:`quickstart`."
msgstr ""
"اینجا را با ترجمه پر کنید. اینجا را با ترجمه پر کنید. :doc:`installation`"
"اینجا را با ترجمه پر کنید. اینجا را با ترجمه پر کنید. :doc:`quickstart`."

لطفا مراقب باشید که نماد reST را نقض نکنید. ³ اکثر ادیتور های po میتوانند به شما کمک کنند.

فصل را به عنوان تمام شده علامت بزنید (چک باکس را با "x" پر کنید):

- [x] مثال @نام‌کاربری_شما نام شما

اگر اولین مترجم هستید، FIRST AUTHOR <EMAIL@ADDRESS> را در بالای فایل های .po با نام و ایمیل خود جایگزین کنید.
مقدار فیلد «Last-Translator» را در بالای فایل «.po» به‌روزرسانی کنید. (اگر از نرم افزاری مانند poedit استفاده میکنید به اینکار نیازی نیست)
تغییرات را کامیت کنید:

$ git add docs/locales/fa/LC_MESSAGES/example.po README.md
$ git commit -m "Translate docs/example"

اسناد ⁴ را بسازید و تغییرات را بررسی ⁵ کنید:

در Linux یا macOS:

$ cd docs
$ make html

در ویندوز:

> cd docs
> .\make.bat html

flask-docs-fa/docs/_build/html/index.html را باز کنید تا اسناد را ببنید.

اگر همه چیز همانطور که انتظار می رود کار می کند، تغییرات را به GitHub پوش کنید:

$ git push origin your-branch-name

صفحه اصلی مخزن انشعاب خود را باز کنید، اعلانی در مورد آن خواهید دید شعبه جدید برای ایجاد PR، روی دکمه «Compare & pull request» کلیک کنید.
سپس PR خود را به Isuse ای که برای ترجمه نوشته اید لینک کنید. برای راحتی میتوانید در PR #شماره_issue را بنویسید.
هماهنگ کننده ترجمه به زودی PR شما را بررسی خواهد کرد. متشکرم!

فهرست کارهای ترجمه

مطمئن شوید که هر بار فقط یک فصل را علامت گذاری کنید، در صورت اتمام فصل اول، یکی دیگر را علامت بزنید تا PR ایجاد شود. مگر اینکه فصل طولانی باشد، ممکن است تکلیف⁶ را بازنشانی کنیم.(اگر تا ده روز دیگر ترجمه را تمام نکنید.)

ترجمه لوگوی فلاسک

flask-logo.png @MDK1384 MDK

docs/

docs/tutorial/ @mmdbalkhi Mohamad Balkhi

docs/deploying/

docs/patterns/ @mmdbalkhi Mohamad Balkhi

docs/api

یاداشت ها و پی نوشت

discord server

Clone your fork repository locally ↩
Syntax ↩
Please be careful not to break reST notation ↩
docs/documents ↩
preview ↩
assignment ↩

greyli/flask-docs-fa