Add naming fidelity guidance to repo-local code agent definition

クローズ 初心者向け
  • 何か問題がありますか？
#4,335 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
86/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
領域
developer-experience, tooling

調査の方向性

.fullsend/rhdh/agents/code.md の Constraints セクションを、提案された名前の忠実性に関するガイダンスで更新します。まず既存の「Keep changes minimal」制約を確認し、その後、新しい条項が明示的に指定された名前を保持することを確認します。検証では、次の3回の該当する code-agent の実行における名前と issue のテキストを比較します。

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

説明

feature ready-for-triage triaged

What happened

On PR #4258, issue #4256 explicitly stated: "Add a new module called catalog" and referenced CatalogMetricProvider as the class name. The code agent (run 31537419298) instead named the module scorecard-backend-module-catalog-metadata, the class CatalogMetadataMetricProvider, and the config key catalogMetadata. The human then requested renaming in fix iteration 5 (renamed folder, classes, IDs — 5 items in a single /fs-fix). The cancelled fix iteration 4 was also related to the same naming mismatch (the human started with example files before deciding to rename everything). This naming deviation caused ~35 minutes of fix agent compute time and required the human to write detailed rename instructions.

What could go better

The code agent definition says "Keep changes minimal. Every line in your diff must be justified by the issue." This should imply naming fidelity, but the agent interpreted the module's purpose (checking metadata attributes) and added the "metadata" qualifier. The issue was explicit about the name — it used backtick-formatted catalog — but the code agent prioritized descriptive naming over specification compliance.

Confidence is moderate. This could be a one-off judgment call, or it could reflect a systematic tendency for code agents to add qualifiers that "improve" names beyond what the issue specifies. The existing "keep changes minimal" constraint is too abstract to catch this — it focuses on code scope, not naming fidelity. A more explicit instruction about preserving issue-specified names would make the expectation concrete.

Uncertainty: the code agent may have been influenced by the issue body mentioning "catalog entity metadata attributes" and reasonably derived a more descriptive name. But when a name is explicitly specified, specification compliance should win over descriptiveness.

Proposed change

Add a naming fidelity clause to the Constraints section of .fullsend/rhdh/agents/code.md:

- When the issue specifies a name for a module, package, class, function, or
  config key (especially in backtick-formatted code spans), use that exact
  name. Do not add qualifiers, prefixes, or suffixes the issue did not
  authorize. If you believe the specified name is misleading or technically
  problematic, note the concern in your commit message but use the specified
  name — the reviewer or human can decide whether to rename.

This clause makes the implicit naming expectation in "keep changes minimal" concrete and specific to naming decisions.

Validation criteria

The next 3 code agent runs on this repo where the issue specifies an explicit name (in backticks or quoted) for a module, class, or config key should use that exact name without modification. If the code agent does add a qualifier, it should document why in the commit message. Verify by comparing the issue-specified name with the code agent's chosen name in the initial PR commit.

Generated by retro agent from https://github.com/redhat-developer/rhdh-plugins/pull/4258

主要言語
TypeScript
スター
51
フォーク
121
平均マージ
1日 14時間
マージ済み PR（30日）
286

環境構築

はじめの一歩

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

redhat-developer/rhdh-plugins のほかの issue

redhat-developer/rhdh-plugins の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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