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

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

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

評価

難易度
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

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

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

似ている issue

Python の issue をもっと見る

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

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