Spec template: name each source file with line ranges, not whole packages

オープン 初心者向け
#29 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

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

調査の方向性

shared/dev-team/skills/orchestrate/references/spec-template.md を開き、提案で言及されている orchestrate スキルの「Read」セクションを読み、次に「Handoffs」セクションを読んでください。提案された <source file>:<start>-<end> 行をテンプレートに追加し、受け入れられる場合はハンドオフの文も追加してください。完了とは、テンプレートがパッケージ全体ではなく正確なファイルと行範囲を求めることを意味しますが、未解決の点(固定されたコミット、fixture エントリ名)はまず owner の決定を必要とします。

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

説明

proposal

Proposal

In the spec template (shared/dev-team/skills/orchestrate/references/spec-template.md), make the "Read" section name each source file that the implementer must study with line ranges, not as a whole package or directory.

This is a proposal, not a decision. The owner accepts or closes it.

The problem

When a task ports code or reproduces the behavior of an existing implementation, the orchestrator usually reads the sources while it writes the design and the spec. The spec then often names the sources at package or directory level ("the X package, with its tests and fixtures"). Each implementer and reviewer reads most of that material again, cold. One observed case: writing the design documents for several related components took approximately 150 KB of source reads, and each of the later implementation specs would have sent an implementer through most of it again.

The orchestrator already knows which parts matter, because it read them. A package-level pointer throws that knowledge away.

The change

In the "Read" section of the template, add a line for source material, for example:

- <source file>:<start>-<end>: <what to take from it> (name the exact module, its tests
  and the fixture entries for this task, with line ranges; not the whole package)

Possibly also a sentence in the orchestrate skill, "Handoffs": when the orchestrator read sources for the design, it gives the implementer the exact files and line ranges it used.

Open points

  • Line ranges go stale if the source moves. A pinned commit of the source makes them stable. Should the template ask for the commit as well?
  • A fixture file with many entries (for example one golden file for several components) needs entry names or IDs, not only line ranges.
主要言語
Python
スター
0
フォーク
0
平均マージ
38分
マージ済み PR(30日)
26

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

似ている issue

Python の issue をもっと見る

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

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