Docs: CONTRIBUTING's local checks omit npm run agent:check, which CI runs on docs and integrations
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- github-actions, node.js, typescript
- Domain
- ci-cd, documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
CONTRIBUTING.md tells contributors to run:
npm ci,npm run typecheck,npm test,npm run buildandnpm 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.
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 4
- Avg merge
- 18h 41m
- Merged PRs (30d)
- 48
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DiffCI/core
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at randomPossibly taken @FredApps claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Agent tools: changed_files lists only the new path of a renamed filePossibly taken @FredApps claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
adapter good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
Similar issues
-
agent-ready area: ui-server priority: p3 type: test
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
schlessera/brain-kit#4249 ·
Maintainers usually reply within 1 day
-
documentation tool triaged
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
can1357/oh-my-pi#19608 · 2 comments ·
Maintainers usually reply within 1 day
-
dependencies tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
bcgov/nr-waste-plus#1549 ·
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
blixvip/solana-tx-parse#18 ·