Finish the Chinese rule reference — DOL001–DOL007

Open Beginner friendly
#81 2 comments 0 reactions 0 assignees View on GitHub

@harbinresearcher is already working on this.

Since Sep 11, 2026.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Use docs/i18n/rules/vi/ as the structural model and compare its index and DOL001–DOL007 pages with the English source pages. Translate the prose into Chinese while preserving code blocks, rule codes, option names, suppression syntax, and CLI flags byte-for-byte; update docs/i18n/README.zh.md to link the new pages. Done when the Chinese index and selected pages are present under docs/i18n/rules/zh/ and the acceptance criteria are met.

Written by the indexing model from the issue text.

Description

documentation good first issue help wanted

A self-contained chunk of #52, and the most concrete one: the Chinese set is started but stops after two pages.

What exists

docs/i18n/rules/zh/ holds DOL021.md and DOL022.md — the datetime family — and the index README.md (#104, thanks @harbinresearcher). The README is already translated at docs/i18n/README.zh.md.

What is missing
  • docs/i18n/rules/zh/DOL001.md … DOL007.md — the queryset family, the most frequently triggered rules in the set.

Take the whole family or a few pages of it — a PR per chunk is better than one large one.

Reference

The Vietnamese set at docs/i18n/rules/vi/ already covers exactly this shape — index plus DOL001–DOL007 — so use it as the model for structure and for how the index links out.

Translate the prose, not the code

Python examples, rule codes, option names and suppression syntax stay byte-identical so they stay copy-pasteable and greppable.

Acceptance criteria
  • Files land under docs/i18n/rules/zh/.
  • Code blocks, DOL*** codes and CLI flags are unchanged from the English source.
  • docs/i18n/README.zh.md links the new pages.
  • The PR confirms you read and write Chinese — I cannot review it myself.
Dominant language
Python
Stars
84
Forks
13
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from FROWNINGdev/django-orm-lens

All issues in FROWNINGdev/django-orm-lens

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.