Docs: translate the `docs/rules/` reference (19 pages, take any chunk)

オープン
  • 何か問題がありますか？
#52 コメント 11 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
64/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
python
領域
documentation

調査の方向性

Choose a language you speak and a small chunk from docs/rules/; first read the English source pages and the corresponding translated README under docs/i18n/ to follow the existing layout. Translate prose while keeping code blocks, rule codes, options, and suppression syntax unchanged. Done means the files mirror the i18n path, the translated README links to them, and the PR names the language and confirms you speak it.

索引モデルが issue の本文から書いたものです。

説明

documentation good first issue help wanted
Context

The README is maintained in four languages — English, Русский, Español and 中文 — but the rule reference under docs/rules/ is English-only. That is 19 pages: one per DOL*** code, plus migrations.md, nplusone.md and the README.md index.

The rule pages are what someone reads at the moment a linter flags their code, which makes them the documentation most worth translating — and they are short and highly structured, so this is a good task to pick up incrementally.

What to change

Mirror the existing i18n layout, e.g. docs/i18n/rules/<lang>/DOL001.md, and link the set from the corresponding translated README.

Translate the prose, not the code. Every page carries bad/good Python examples, rule codes, option names and suppression syntax — those stay byte-identical so they remain copy-pasteable and greppable. What gets translated is the explanation, the rationale, and the "why this matters" text around them.

Scope — take as little as you like

This does not have to be all 19 pages, and it does not have to be a language already covered. Sensible units of work:

  • the index (docs/rules/README.md) alone, so the section has an entry point;
  • one rule family — DOL001–DOL007 (queryset), DOL011–DOL015 (model definition), DOL021–DOL022 (datetime), DOL031–DOL032 (forms/views);
  • nplusone.md and migrations.md, the two long-form pages.

Open a PR per chunk rather than saving them up — partial coverage is genuinely useful, and a huge PR is harder to review.

Please only translate into a language you actually speak. Machine-translated technical documentation is worse than no translation, and I have no way to review a language I do not read.

Acceptance criteria
  • Files land under a path mirroring the existing docs/i18n/ convention.
  • Code blocks, rule codes and CLI flags are unchanged from the English source.
  • The matching translated README links to the new pages.
  • The PR names the language and confirms you speak it.
Note

docs/ is excluded from the GitHub Pages build, so these pages are read on GitHub — relative links between them work normally there.

主要言語
Python
スター
84
フォーク
13
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

FROWNINGdev/django-orm-lens のほかの issue

FROWNINGdev/django-orm-lens の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。