Skip to content

Commit 9bca84d

Browse files
feat: add AGENTS.md, CLAUDE.md, CONTRIBUTING.md, and copilot-instructions.md
Establish the guidance chain for agents and contributors: - AGENTS.md: OKF-style pointer file with discovery order and links to PSModule/docs and MSXOrg/docs - CLAUDE.md: Claude Code entry point that imports AGENTS.md - .github/copilot-instructions.md: Copilot entry point pointing to AGENTS.md - CONTRIBUTING.md: self-contained contribution workflow for the template repo Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent a57f0c1 commit 9bca84d

4 files changed

Lines changed: 95 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Copilot Instructions
2+
3+
See [`AGENTS.md`](../AGENTS.md) for all onboarding and guidance pointers for this repository.

AGENTS.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Agents
2+
3+
This file is the onboarding entry point for agents working in this repository.
4+
It is a pointer file — guidance lives in the documentation, not here.
5+
6+
## This repository
7+
8+
`Template-PSModule` is the canonical starting template for new PowerShell modules in the PSModule organization.
9+
It provides the CI/CD framework wiring, starter layout, and community files that every PSModule module repository begins with.
10+
11+
Read in this order:
12+
13+
1. [`README.md`](README.md) — what this repository is and its purpose as a template.
14+
2. [`CONTRIBUTING.md`](CONTRIBUTING.md) — how to work on the template itself.
15+
3. [`.github/PSModule.yml`](.github/PSModule.yml) — framework configuration defaults.
16+
17+
## PSModule guidance
18+
19+
For PSModule-specific build, layout, and process guidance:
20+
21+
- [Template quickstart](https://psmodule.github.io/docs/Modules/Process-PSModule/template-quickstart/) — how to create a new module from this template.
22+
- [Repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) — the expected repository layout and required files.
23+
- [Module anatomy](https://psmodule.github.io/docs/Modules/module-anatomy/) — source layout and framework conventions.
24+
- [Build, test, pack, publish](https://psmodule.github.io/docs/Modules/Process-PSModule/build-test-pack-publish/) — the CI/CD pipeline.
25+
- [Standards](https://psmodule.github.io/docs/Modules/Standards/) — PowerShell module coding standards.
26+
27+
## Org-wide guidance
28+
29+
For cross-cutting ways of working and standards:
30+
31+
- [Agentic Development](https://msxorg.github.io/docs/Ways-of-Working/Agentic-Development/) — how agents and humans collaborate in this ecosystem.
32+
- [Ways of Working](https://msxorg.github.io/docs/Ways-of-Working/) — contribution workflow, branching, PRs, issues.
33+
- [Coding Standards](https://msxorg.github.io/docs/Coding-Standards/) — language-level conventions.
34+
35+
## Main directive
36+
37+
Everything is a work in progress and can be improved.
38+
If you find a problem, fix it if it is small; otherwise open an issue in the relevant repository.

CLAUDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Claude
2+
3+
See [`AGENTS.md`](AGENTS.md) for all onboarding and guidance pointers for this repository.

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
Thank you for contributing to `Template-PSModule`.
4+
This file describes how to work on the template itself — not how to use it.
5+
If you want to create a new module from this template, see the [template quickstart](https://psmodule.github.io/docs/Modules/Process-PSModule/template-quickstart/).
6+
7+
## What this repository is
8+
9+
`Template-PSModule` is the canonical starting template for new PowerShell modules in the PSModule organization.
10+
Changes to this repository affect every module created from it going forward.
11+
Keep changes focused: structural layout, required community files, CI/CD wiring, and framework defaults.
12+
13+
## Before you start
14+
15+
1. Read [`AGENTS.md`](AGENTS.md) for the guidance chain and documentation references.
16+
2. Familiarise yourself with the [repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) that this template must satisfy.
17+
3. Check the open issues and pull requests to avoid duplicate work.
18+
19+
## Workflow
20+
21+
This project follows the [MSXOrg contribution workflow](https://msxorg.github.io/docs/Ways-of-Working/Contribution-Workflow/):
22+
23+
1. Open or pick up an issue that describes the change.
24+
2. Create a branch from `main` following the `<type>/<issue>-<short-slug>` convention (e.g. `feat/42-add-security-md`).
25+
3. Make small, focused commits and push often.
26+
4. Open a **draft PR** as soon as the change has a basic shape — early feedback is preferred.
27+
5. Mark the PR ready for review once CI is green and the change is complete.
28+
29+
For branching details, see [Branching and Merging](https://msxorg.github.io/docs/Ways-of-Working/Branching-and-Merging/).
30+
31+
## Pull requests
32+
33+
- Keep PRs small and focused on a single deliverable.
34+
- The PR title should follow the [commit conventions](https://msxorg.github.io/docs/Ways-of-Working/Commit-Conventions/).
35+
- Auto-merge is enabled; the PR lands as soon as all required checks pass and a reviewer approves.
36+
37+
For PR format guidance, see [PR Format](https://msxorg.github.io/docs/Ways-of-Working/PR-Format/).
38+
39+
## Issues
40+
41+
Use GitHub Issues to report bugs, request features, or propose template changes.
42+
Follow the [issue format](https://msxorg.github.io/docs/Ways-of-Working/Issue-Format/) guidance.
43+
44+
## Code standards
45+
46+
PowerShell in this template follows the [PSModule Standards](https://psmodule.github.io/docs/Modules/Standards/) and the
47+
[MSXOrg Coding Standards](https://msxorg.github.io/docs/Coding-Standards/).
48+
49+
## Questions
50+
51+
Open a GitHub Discussion or file an issue if something is unclear.

0 commit comments

Comments
 (0)