Document Repo Folders Constraints in /docs

Fermée
  • Quelque chose ne va pas ?
#26 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

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

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
Une demi-journée
Accessibilité débutants
68/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Domaine
documentation

Piste de recherche

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.

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

Description

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:

Langage dominant
Aucune donnée de langage
Étoiles
1
Forks
0
Merge moyen
6 min
PR mergées (30 j)
19

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

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

Toutes les issues de jeromeetienne/coding_agent_plugin

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

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