Start the Spanish rule reference — the index and the queryset family DOL001–DOL008

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

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
49/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

Read docs/i18n/rules/it/README.md for the partial-locale approach and use docs/i18n/rules/vi/ as a complete-translation reference. Compare the English rule pages and docs/rules/README.md for canonical metadata, then check docs/i18n/README.es.md for the link to add. Done means the Spanish index and DOL001–DOL008 pages preserve code and metadata, track the English structure, and the README links the section; the PR must confirm Spanish proficiency.

由索引模型根据 Issue 内容生成。

描述

documentation good first issue help wanted

A self-contained chunk of #52, and the one with the widest reach: docs/i18n/README.es.md is already translated, so Spanish readers arrive at the project in their own language and then hit an English-only rule reference.

What exists

docs/i18n/README.es.md — the project README in Spanish. Nothing under docs/i18n/rules/es/ yet.

What is missing
  • docs/i18n/rules/es/README.md — the index. Without it a translated page has no entry point, so a reader who lands on one rule has no way to discover the rest.
  • docs/i18n/rules/es/DOL001.md … DOL008.md — the queryset family, the most frequently triggered rules in the set.

The index alone is a genuinely useful first PR and takes an evening. Take that, or one family, or both — a PR per chunk is better than one large one.

Reference
  • docs/i18n/rules/it/README.md is the model for starting a locale: it covers one family and says so plainly, linking out to the full English reference for the rest. That honesty is the right call when a locale covers 8 rules out of 22, and it is what this issue should copy.
  • docs/i18n/rules/vi/ is the only complete locale — all 22 pages — so it shows what finished looks like.
Translate the prose, not the code

Python examples, rule codes, option names and suppression syntax stay byte-identical to the English source, so they stay copy-pasteable and greppable. django-orm-lens-disable-next-line is directive syntax, not prose — it does not get translated.

Two things checked on every translation PR, because a previous batch (#90) had to be rewritten for missing them:

  • The index table repeats the canonical category, default severity and applicability from docs/rules/README.md unchanged. Translate the description, leave the metadata alone.
  • Line count and heading structure track the English source.
Acceptance criteria
  • Files land under docs/i18n/rules/es/.
  • Code blocks, DOL*** codes and CLI flags are unchanged from the English source.
  • docs/i18n/README.es.md links the new section.
  • The PR confirms you read and write Spanish — I cannot review it myself.
主要语言
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 摘要。