yuxiaoy1/flask-docs-zh

Flask 文档中文翻译

Flask Docs Translation

Contributing Guide

Installation

• Click the "Fork" button to fork this repository on GitHub.
• Clone your fork repository locally (replace {username} with your username):

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

• Create a virtual environment and install requirements:

For Linux/macOS:

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

For 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

Self-Assignment

• Open your fork repository on GitHub.
• Click the "Fetch upstream" button to update your fork.
• Click the edit button (a pencil icon in the upper right corner of the README) to edit the README.
• Find the "Translation To-do List" section, mark the chapter you want to translate in following format:

- [ ] example.rst @your_username Your Name

You can link the username to your GitHub profile:

- [ ] example.rst [@your_username](https://github.com/your_username) Your Name

• Leave a commit message (e.g., "Assign docs/example.rst to @your_username"), then select "Create a new branch for this commit and start a pull request" and click the "Commit changes" button to create a PR.

Translation

• When the self-assignment PR is merged, create a new branch base on "2.0.x" branch locally (be sure to update the example branch name, for example, translate-cli):

$ git fetch upstream
$ git checkout -b your-branch-name upstream/2.0.x

If you're adding new contents for a new feature docs merged in the main branch of Flask, branch off of the "main" branch:

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

• Translate the file, then fill the checkbox in the README to indicate you have finished it:

- [x] example.rst @your_username Your Name

Commit the changes:

$ git add docs/foo.rst README.md
$ git commit -m "Translate docs/foo.rst"

• Build and test the docs with tox command:

$ tox
  ...
  docs: commands succeeded
  congratulations :)

Open /tox/docs/tmp/html/index.html in your browser to view the docs.

• If everything is working as expected, push the changes to GitHub:

$ git push origin your-branch-name

• Open the home page of your forked repository, you will see a notice about the new branch. Click the "Create pull request" button to create a PR, choose 2.0.x as the base branch.
• The translation coordinator will review your PR very soon. Thank you!

Translation To-do List

Be sure only mark one chapter at a time, make another one when the former PR is created. Unless it's a long chapter, we may reset the assignment if you doesn't finish the translation in ten days.

docs/

• advanced_foreword.rst
• appcontext.rst
• async-await.rst
• becomingbig.rst
• blueprints.rst
• changes.rst
• cli.rst
• config.rst
• contributing.rst
• debugging.rst
• design.rst
• errorhandling.rst
• extensiondev.rst
• extensions.rst
• foreword.rst
• htmlfaq.rst
• index.rst @greyli Grey Li
• installation.rst
• logging.rst
• quickstart.rst
• reqcontext.rst
• security.rst
• server.rst
• shell.rst
• signals.rst
• templating.rst
• testing.rst
• views.rst

docs/tutorial/

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

docs/deploying/

• asgi.rst
• cgi.rst
• fastcgi.rst
• index.rst
• mod_wsgi.rst
• uwsgi.rst
• wsgi-standalone.rst

docs/patterns/

• appdispatch.rst
• appfactories.rst
• caching.rst
• celery.rst
• deferredcallbacks.rst
• distribute.rst
• fabric.rst
• favicon.rst
• fileuploads.rst
• flashing.rst
• index.rst
• jquery.rst
• lazyloading.rst
• methodoverrides.rst
• mongoengine.rst
• packages.rst
• requestchecksum.rst
• singlepageapplications.rst
• sqlalchemy.rst
• sqlite3.rst
• streaming.rst
• subclassing.rst
• templateinheritance.rst
• urlprocessors.rst
• viewdecorators.rst
• wtforms.rst

src/flask/

Only the docstring and attribute comments in the source need to be translated.

• app.py
• blueprints.py
• cli.py
• config.py
• ctx.py
• debughelpers.py
• globals.py
• helpers.py
• logging.py
• scaffold.py
• sessions.py
• signals.py
• templating.py
• testing.py
• views.py
• wrappers.py
• json/