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

Ouverte
#288 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@FredApps y travaille déjà.

Depuis le 17/11/2026.

  • #289 par @FredApps — ouverte

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
github-actions, node.js, typescript
Domaine
ci-cd, documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
0
Forks
4
Merge moyen
18 h 41 min
PR mergées (30 j)
48

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de DiffCI/core

Toutes les issues de DiffCI/core

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.