Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Two always-loaded agent-instruction surfaces (AGENTS.md and .github/copilot-instructions.md) with no precedence rule

Aperta
  • Qualcosa non va?
#1,785 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
github-actions
Ambito
documentation

Direzione di ricerca

Leggi AGENTS.md, in particolare la relativa sezione «Maintaining this file», quindi confrontalo con .github/copilot-instructions.md e con i riferimenti CI documentati in .github/workflows/node-checks.yml e README.md. Decidi e documenta la relazione prevista tra i file di istruzioni, assicurandoti che la policy scelta e gli eventuali puntatori o limiti di ambito necessari siano scritti in AGENTS.md e riflessi nei file interessati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Summary

This repo carries two always-loaded agent-instruction surfaces covering the same ground: AGENTS.md (with CLAUDE.md as a symlink to it) and .github/copilot-instructions.md. Both describe build commands, architecture, and conventions. Nothing states which one wins, so they drift independently - and they already have.

The drift is not hypothetical

The CI Node matrix is currently stated in three places, and two of the three are wrong:

Source Says
.github/workflows/node-checks.yml (the owner) [22, 24]
.github/copilot-instructions.md "Node 20 and 22"
README.md:19 "node@16, node@18 and node@20"

An agent or contributor reading either prose copy gets a wrong answer about what CI actually runs, and the README copy is wrong by two major versions.

layer5io/sistent#1780 fixes those two prose copies by reducing them to a pointer at the workflow, which is the pattern AGENTS.md already prescribes for itself ("Do not repeat what the codebase already shows; point to the authoritative file or command instead"). That closes the immediate factual error but not the structural one.

The structural question

AGENTS.md has a ## Maintaining this file section setting a deliberate bar: keep it to knowledge useful to almost every session, point at authoritative sources rather than restating them, prefer rewriting over appending. .github/copilot-instructions.md has no equivalent governance and no stated relationship to AGENTS.md, so:

  • a maintainer updating one has no signal that the other exists;
  • an agent loading both gets the same territory twice, with no precedence rule for conflicts;
  • every fact restated in both is a future drift like the one above.

What to decide

One of:

  1. Retire copilot-instructions.md, or reduce it to a short pointer at AGENTS.md. Copilot reads whatever is at that path; a stub that redirects costs nothing and removes the second copy.
  2. Keep it, and give it a scope that does not overlap - Copilot-specific mechanics only, with everything shared living in AGENTS.md.
  3. Keep both as-is and accept the duplication, in which case say so explicitly in both files so the next maintainer knows the redundancy is intentional and updates both.

Whichever is chosen, the outcome should be written down in AGENTS.md's ## Maintaining this file section, since that is the file that currently claims to govern agent knowledge in this repo.

Raised from the schema-consumer audit in layer5io/sistent#1780, which found the Node-matrix discrepancy while checking whether the change had invalidated any documented fact. Deliberately not resolved there - fixing the wrong facts is in scope for that PR; deciding whether the second instruction surface should exist is not.

Lingua principale
TypeScript
Stelle
137
Fork
239
Merge medio
4g 14h
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di layer5io/sistent

Tutte le issue di layer5io/sistent

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.