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

未关闭
  • 哪里不对？
#52 11 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
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. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

FROWNINGdev/django-orm-lens 的其他 Issue

查看 FROWNINGdev/django-orm-lens 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。