Document Repo Folders Constraints in /docs

Aperta
  • Qualcosa non va?
#26 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

Read skills/repo_folders_constraints/SKILL.md as the authoritative source, then docs/rules_of_the_repo.md for the existing overview, and skills/docs_folder_system/SKILL.md for the required metadata header and link conventions. Write a new document in /docs that explains the rules in plain English without copying the procedure. Done when the new page is linked from docs/README.md and docs/index.md, links back from docs/rules_of_the_repo.md, and all relative links resolve.

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

Descrizione

Purpose

Add an explanation in /docs of Repo Folders Constraints: what the rules of repository folders and packages are, why those rules exist, and how a human and a coding agent use those rules.

The existing The Rules of the Repo documentation introduces Repo Folders Constraints. Provide a dedicated explanation for people who need to understand and adopt Repo Folders Constraints.

Documentation to include

  • What a folder or package rule records: responsibility, prohibited content or behavior, permitted imports between packages, required language and technologies, and the workflow for changing content.
  • How one human-owned rules file holds the rules, with separate tables for packages and other folders.
  • How the caller supplies the rules file path, both through The Rules of the Repo and through direct repository configuration.
  • When a coding agent reads and checks the rules, including adding files, changing folders, adding dependencies between packages, and changing required technologies.
  • What happens when configuration is missing, a folder has no rule, or a decision is marked “not decided yet”.
  • How a proposed rule change receives human approval through Approve, Cancel, or Refine.
  • How Repo Folders Constraints differs from agent-maintained context notes, and which source takes precedence when the sources disagree.
  • A small example rules table and a concrete example of a proposed folder change and its review.

Use the Repo Folders Constraints instructions as the authoritative source and link to the instructions rather than copying the full procedure. Explain the relationship to The Rules of the Repo without repeating the existing documentation.

Acceptance criteria

  • A dedicated document in /docs explains Repo Folders Constraints in plain English and covers the topics above.
  • The document follows Docs folder system, including the metadata header and working relative links.
  • The documentation overview and the documentation index link to the new document.
  • The existing The Rules of the Repo documentation links to the dedicated explanation where appropriate.
  • The documentation describes the existing skill; documentation work does not introduce or change repository folder rules.

Related work

The broader explanation of The Rules of the Repo was completed here:

Lingua principale
Nessun dato sulla lingua
Stelle
1
Fork
0
Merge medio
10m
PR unite (30g)
11

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 jeromeetienne/coding_agent_plugin

Tutte le issue di jeromeetienne/coding_agent_plugin

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.