Document Repo Folders Constraints in /docs

Geschlossen
  • Stimmt etwas nicht?
#26 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
Ein halber Tag
Anfängerfreundlichkeit
68/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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:

Vorherrschende Sprache
Keine Sprachdaten
Sterne
1
Forks
0
Ø Merge
6 Min.
Gemergte PRs (30 T.)
19

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus jeromeetienne/coding_agent_plugin

Alle Issues in jeromeetienne/coding_agent_plugin

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.