Document the issue → branch → PR contribution workflow in AGENTS.md
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 90/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Ambito
- documentation
Direzione di ricerca
Il lavoro consiste nel modificare AGENTS.md, aggiungendo una sezione 'Flusso di lavoro per i contributi'. Iniziare leggendo i file esistenti AGENTS.md e CONTRIBUTING.md per comprenderne il contenuto e lo stile attuali. La nuova sezione dovrebbe dettagliare i sei passaggi elencati nell'issue, inclusi comandi gh di esempio. Verificare le modifiche controllando il file localmente e assicurandosi che le istruzioni siano chiare e attuabili.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is your feature request related to a problem?
AGENTS.md is the operating guide for coding agents working in this repo, and it documents structure, commands, architecture, conventions and test layout — but says nothing about how a change is supposed to land. An agent reading it has no way to know that this repo expects issue → branch → PR.
The result is predictable and has already happened in practice:
- work started directly on an already-merged branch instead of a fresh branch off
main, because merged branches linger locally andgit branch --show-currentlooks unremarkable; - changes made with no issue behind them, so the rejected alternatives are never written down anywhere;
- PRs opened without a
Closes #Nkeyword, leaving issues to be closed by hand.
CONTRIBUTING.md covers some of this for humans, but it is thin on the points agents actually get wrong: it says "create a feature branch" without specifying the base, does not mention issues at all, does not mention Conventional Commits, and does not mention the label taxonomy. It also is not the file agents are pointed at.
Describe the solution
Add a "Contribution Workflow" section to AGENTS.md covering the six steps the repo already expects in practice:
- Open an issue first, using the
.github/ISSUE_TEMPLATE/structure, recording the problem withfile:lineevidence and the alternatives that were rejected. - Label it —
Type: *required,Status: Break Changefor CLI/config/wire changes,Priority: P0–P3for bugs. - Branch off
main, never off another feature branch, withfeat/…fix/…docs/…spec/…naming, verified againstgit log origin/main --oneline -1. - Commit with Conventional Commits — the release pipeline derives version bumps from the type, so it is not cosmetic.
- Open the PR with a
Closes #Nkeyword and fill in the PR template honestly. - Verify before marking ready, with pasted evidence rather than claims.
Include the gh invocations for each step, including gh pr view --json closingIssuesReferences to confirm the issue link actually landed.
Describe alternatives
- Put it in
CONTRIBUTING.mdonly. Rejected: that file is aimed at human contributors and is not what agents are pointed at. The failure being fixed here is an agent-facing one. - Leave it implicit and correct it in review. Rejected: it recurs every session, since agents start with no memory of the previous correction.
- Duplicate the full text into both files. Rejected: two copies drift.
AGENTS.mdgets the operational detail;CONTRIBUTING.mdstays the human-facing summary.
Which implementation(s) would this affect?
- Go
- Rust
- TypeScript
- Quint specification
- All
Documentation only — no implementation code is touched.
Additional context
Split out of #35, which is where the gap surfaced.
- Lingua principale
- Rust
- Stelle
- 2
- Fork
- 0
- Merge medio
- 9h 35m
- PR unite (30g)
- 6
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ChainSafe/docker-socket-policy
-
Priority: P1 Type: Bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
Priority: P2 Type: Enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
Status: Break Change Type: Enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
Process exits 0 (Rust) / hangs (Go) when all listeners fail to bind — defeats Restart=on-failure ApertaPriority: P2 Type: Bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 65/100
-
Priority: P3 Type: Enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 64/100
Tutte le issue di ChainSafe/docker-socket-policy
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
TheLarkInn/aipm#2413 ·
-
documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
alexgorbatchev/simple-ptt#15 ·
-
tooling
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
todo:ticket
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
taikoxyz/taiko-mono#22168 · 1 commento ·