Document Repo Folders Constraints in /docs

クローズ
  • 何か問題がありますか？
#26 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
半日
初心者へのやさしさ
68/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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:

主要言語
言語のデータがありません
スター
1
フォーク
0
平均マージ
7分
マージ済み PR（30日）
17

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

jeromeetienne/coding_agent_plugin のほかの issue

jeromeetienne/coding_agent_plugin の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。