فلسک

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

نصب

• روی دکمه 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 wheel
$ 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

ترجمه

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

سپس یک برنچ با نام بخشی({name} را با نام برنچ خودتان جایگزین کنید) که می‌خواهید ترجمه کنید ایجاد کنید:

$ git fetch upstream
$ git checkout -b {name} upstream/main

و تغییرات خود را در اینجا انجام دهید.

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

• POEdit پیشنهاد اصلی ما POEdit است و خیلی از مترجمان از آن استفاده میکنند!

• lokalize نرم افزاری دیگر از KDE که شاید بخواهید از آن استفاده کنید.

مطمئنا نرم افزار‌های دیگری نیز برای ویرایش فایل های po وجود دارد. برخی از آن برنامه ها را می‌توانید از اینجا بیابید

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

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

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

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

شروع ترجمه

فایل‌های ترجمه در docs/locales/fa/LC_MESSAGES قرار دارد. فایل انتخابی خود با با نرم افزار مورد علاقه خودتان باز کنید و ترجمه را شروع کنید.

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

• فایل .po را اینگونه ترجمه کنید:

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

البته دقت کنید که بعضی از موارد نباید ترجمه شوند مثل :doc:`installation` و در مثال زیر :doc:`quickstart`:

#: ../../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`."

این راهنما شاید بتواند کمک کند: راهنما

اتمام ترجمه

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

- [x] example [@mmdbalkhi](https://github.com/mmdbalkhi/) Komeil Parseh

تغییرات را کامیت کنید:

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

بررسی و تست

برای ساختن مستندات کار‌های زیر را انجام دهید:

• در Unix/Linux از دستورات زیر استفاده کنید:

$ cd docs
$ make dirhtml
$ python -m http.server --directory _build/dirhtml

در ویندوز:

> cd docs
> .\make.bat dirhtml
> python -m http.server --directory _build\dirhtml

سپس در مرورگر خود این آدرس را باز کنید تا تغییرات را مشاهده کنید:

• http://127.0.0.1:8000

اگر همه چیز خوب باشد تغییرات خودتان را پوش کنید({name} را با نام برنچ خودتان جایگزین کنید).

$ git push origin {name}

ایجاد یک PR

• به فورک خود بروید. یک اعلانی خواهید دید. روی Compare & pull request کلیک کنید تا یک PR ایجاد کنید.
• اطلاعات درخواست شده در PR را تکمیل کنید
• ممنونم! PR شما را بررسی خواهیم کرد.

فهرست ترجمه

docs/

• advanced_foreword @mmdbalkhi Komeil Parseh
• async-await
• blueprints
• changes
• cli
• config
• contributing @mdk84 MDK
• debugging @mmdbalkhi Komeil Parseh
• design
• errorhandling @mmdbalkhi Komeil Parseh
• extensiondev @mmdbalkhi Komeil Parseh
• extensions @mdk84 MDK
• foreword @mmdbalkhi Komeil Parseh
• htmlfaq
• index @mmdbalkhi Komeil Parseh
• installation @mmdbalkhi Komeil Parseh
• logging @mmdbalkhi Komeil Parseh
• quickstart @mmdbalkhi Komeil Parseh
• reqcontext
• security
• server @Abol-010 Abol
• shell @ja74d Javad Pournosrat
• signals
• templating @mmdbalkhi komeil parseh
• testing @mmdbalkhi komeil parseh
• views

docs/tutorial/ @mmdbalkhi Komeil Parseh

• blog
• database
• deploy
• factory
• index
• install
• layout
• next
• static
• templates
• tests
• views

docs/deploying/

• asgi @mdk84 MDK
• index
• mod_wsgi
• uwsgi
• wsgi-standalone

docs/patterns/ @mmdbalkhi Komeil Parseh

• appdispatch @mmdbalkhi Komeil Parseh)
• appfactories
• caching
• celery
• deferredcallbacks
• distribute
• fabric
• favicon
• fileuploads
• flashing
• index @mmdbalkhi Komeil Parseh
• jquery
• lazyloading
• methodoverrides
• mongoengine
• packages @mmdbalkhi Komeil Parseh
• requestchecksum
• singlepageapplications
• sqlalchemy
• sqlite3
• streaming
• subclassing
• templateinheritance
• urlprocessors @mmdbalkhi Komeil Parseh
• viewdecorators
• wtforms

docs/api

• L0~L1000
• L1000~L1500
• L1500~L2000
• L2000~L2500
• L2500~L3000
• L3000~L3500
• L3500~L4000
• L4000~L4500
• L4500~L5000
• L5000~L5500
• L5500~L6000
• L6000~L6500