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

Đang mở
#288 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@FredApps đang làm issue này rồi.

Từ ngày 17/11/2026.

  • #289 của @FredApps — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions, node.js, typescript
Lĩnh vực
ci-cd, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
0
Fork
4
Merge trung bình
18 giờ 41 phút
Pull request đã merge (30 ngày)
48

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của DiffCI/core

Tất cả issue của DiffCI/core

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.