diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6ca1a01 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing to PSModule/docs + +This repository is the source of truth for PSModule documentation. + +## Before you change docs + +- Read the relevant page in `src/docs/` first. +- Keep changes small and scoped to one topic. +- Prefer links to canonical docs over duplicating guidance. + +## Working in this repository + +- Use the current branch or worktree for the change. +- Keep commit messages short and specific. +- Open draft pull requests early for reviewable doc updates. + +## Review expectations + +- Make wording changes that improve clarity without widening scope. +- Preserve the existing PSModule doc conventions and link patterns. +- If a linked guide is missing, add it here in the repository instead of relying on inheritance. diff --git a/src/docs/Modules/Repository-Defaults.md b/src/docs/Modules/Repository-Defaults.md index f26135e..3530bc1 100644 --- a/src/docs/Modules/Repository-Defaults.md +++ b/src/docs/Modules/Repository-Defaults.md @@ -54,7 +54,7 @@ Local work should use the organization worktree convention: - `main/` tracks the default branch. - Feature worktrees use `-` directories and `/` branches. -For branch and worktree details, see [Git Worktrees](../../Ways-of-Working/Git-Worktrees.md). +For branch and worktree details, see [Git Worktrees](https://github.com/MSXOrg/docs/blob/main/src/docs/Ways-of-Working/Git-Worktrees.md). ## Default repository layout @@ -134,7 +134,8 @@ Every repository must be usable by an agent that has never seen it before, witho - `AGENTS.md`: the cross-tool entry point, read by the GitHub Copilot coding agent, VS Code, and other AGENTS.md-aware tools. It names what the repository is in a line or two and points to the canonical agent guidance in [`PSModule/docs`](https://github.com/PSModule/docs). - `CLAUDE.md`: a thin file that imports `AGENTS.md` with `@AGENTS.md` so Claude Code reads the same instructions. Claude-specific notes, if any, go below the import. -- `.github/copilot-instructions.md`: repository instructions for VS Code and GitHub Copilot that point to the same documentation. + +See [PSModule/Template-PSModule](https://github.com/PSModule/Template-PSModule) for a concrete implementation example of `AGENTS.md` and `CLAUDE.md`. These files are the agent equivalent of the README: pointers, not copies. Keep them short so the linked documentation stays the single source of truth. Like the other governance files, they live in the repository itself so it can stand on its own.