ce-compound: line-number citations go stale quickly, and are checked against the working tree even when it holds unrelated changes

オープン
#2,083 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python, typescript

調査の方向性

Start with skills/ce-compound/references/research.md Phase 1 and grounding-validation.md, then inspect validate-doc-claims.py to see how it handles paths and citation line suffixes. Trace how capture and refresh choose the tree used for code-behavior citations. Done when citations prefer symbol anchors where possible, verification uses and identifies the intended base tree, and refresh recognizes citations that still match the default branch.

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

説明

ce-compound's capture step asks the drafter to "cite file:line alongside the claim" from the current tree (skills/ce-compound/references/research.md, Phase 1 draft step), and grounding-validation.md says code-behavior claims verify against the local working tree. This causes two problems.

  1. Line numbers go stale whenever lines are added or removed above them. In one repo using ce-compound, a single refresh pull request updated 70 learnings, most of them only to move line numbers, and a second branch existed just to update one learning's citations again. Neither change corrected anything a reader needed. The code had moved, and the numbers had not. validate-doc-claims.py strips :line suffixes before checking, so nothing flags a stale number until someone reads it.

  2. The working tree is not always the tree the learning will merge into. In a GitButler workspace, or any checkout with other unmerged work applied, the working tree includes changes that are not part of the learning's pull request. In one session, a capture wrote line numbers that were 4-7 lines off from the base branch, and a refresh investigation recommended "correcting" about ten citations that were right on the base branch to the working-tree values. On an ordinary feature branch this does not arise, because the learning merges with the code it cites.

Suggested changes:

  • Prefer symbol anchors (function, class, or config key names) over line numbers when citing code in a learning, and keep file:line for cases where no symbol identifies the spot.
  • When HEAD is not the default branch's tip, verify code-behavior citations against the merge base or the default branch, as validate-doc-claims.py already does for paths, and state which tree was used.
  • In refresh, do not classify a citation as drifted when it matches the default branch.
主要言語
TypeScript
スター
25.6k
フォーク
2.1k
平均マージ
3時間 57分
マージ済み PR(30日)
170

環境構築

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

はじめの一歩

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

EveryInc/compound-engineering-plugin のほかの issue

EveryInc/compound-engineering-plugin の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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