Docs: CONTRIBUTING's local checks omit npm run agent:check, which CI runs on docs and integrations

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

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

@FredApps がすでに取り組んでいます。

2026年11月17日 から。

  • #289 @FredApps による — オープン

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
github-actions, node.js, typescript

調査の方向性

Read CONTRIBUTING.md and compare its local check list with the check job in .github/workflows/ci.yml. Check scripts/check-agent-packaging.mjs to summarize what npm run agent:check validates, and mention that CI also runs npm run benchmark. Update the contributor instructions to include both checks; done when the documented commands and coverage match the issue's expected behavior.

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

説明

CONTRIBUTING.md tells contributors to run:

npm ci, npm run typecheck, npm test, npm run build and npm run audit:boundary

Core CI's check job (.github/workflows/ci.yml, on main @ 40aa308) runs those, plus npm run agent:check and npm run benchmark.

agent:check (scripts/check-agent-packaging.mjs) reads tracked docs and integration files. It fails when docs/agent-installation.md pins a @diffci.com/[email protected] other than the CLI package version, and when the agent-plugin, Muse, GitLab component or Azure DevOps version pins drift. A contributor who edits docs/agent-installation.md or an integration and runs the listed checks gets a red CI job they could not reproduce locally.

Reproduce: on main, change one @diffci.com/[email protected] in docs/agent-installation.md to 0.3.53. The checks CONTRIBUTING lists all still pass, but npm run agent:check fails with "Agent installation guide pins other CLI versions: 0.3.53."

Expected: CONTRIBUTING lists npm run agent:check with the other local checks, and says what it covers. It should also mention that CI runs npm run benchmark.

Docs-only.

主要言語
TypeScript
スター
0
フォーク
4
平均マージ
18時間 41分
マージ済み PR(30日)
48

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

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

DiffCI/core のほかの issue

DiffCI/core の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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