Skip to content

Commit e56bf6b

Browse files
Align agent and contribution guidance
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent d92cdc6 commit e56bf6b

2 files changed

Lines changed: 16 additions & 74 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 8 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,12 @@
11
# Contributing
22

3-
Thank you for investing your time in contributing to this repository.
4-
Read the [PSModule Code of Conduct](https://github.com/PSModule/.github/blob/main/.github/CODE_OF_CONDUCT.md)
5-
before participating, and read
6-
[`AGENTS.md`](../AGENTS.md) for the full guidance chain and documentation references.
3+
Follow the central [MSX contribution workflow](https://msx.no/docs/Ways-of-Working/Contribution-Workflow/)
4+
for how to select work, create a branch, make commits, open a draft pull request, request review,
5+
and merge changes. Use the [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/) for the
6+
shared issue, branching, commit, pull request, and review conventions.
77

8-
## Before you start
8+
Use the Process-PSModule documentation for repository-specific standards:
99

10-
1. Read [`README.md`](../README.md) to understand the repository's purpose.
11-
2. Familiarize yourself with the [repository standard](https://psmodule.io/Process-PSModule/reference/repository-standard/).
12-
3. Check the open issues and pull requests to avoid duplicate work.
13-
14-
## Workflow
15-
16-
This project follows the [MSX contribution workflow](https://msx.no/docs/Ways-of-Working/Contribution-Workflow/):
17-
18-
1. Open or pick up an issue that describes the change.
19-
2. Create a branch from `main` following the `<type>/<issue>-<short-slug>` convention.
20-
3. Make small, focused commits and push often.
21-
4. Open a **draft pull request** as soon as the change has a basic shape.
22-
5. Run the **Copilot review loop** until it reports a clean round. File an issue for out-of-scope findings.
23-
6. Mark the pull request ready for review and enable auto-merge.
24-
25-
For branching details, see [Branching and Merging](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/).
26-
27-
## Pull requests
28-
29-
- Keep pull requests small and focused on a single deliverable.
30-
- Follow the [commit conventions](https://msx.no/docs/Ways-of-Working/Commit-Conventions/).
31-
- Follow the [pull request format](https://msx.no/docs/Ways-of-Working/PR-Format/).
32-
33-
## Issues
34-
35-
Use GitHub Issues to report bugs, request features, or propose improvements.
36-
Follow the [issue format](https://msx.no/docs/Ways-of-Working/Issues/Process/Format/).
37-
38-
## Code standards
39-
40-
PowerShell in this repository follows the
41-
[PSModule PowerShell module standard](https://psmodule.io/Process-PSModule/reference/powershell-module-standard/)
42-
and the [MSX coding standards](https://msx.no/docs/Coding-Standards/).
43-
44-
## Questions
45-
46-
Follow the [PSModule support guidance](https://github.com/PSModule/.github/blob/main/.github/SUPPORT.md).
47-
Report vulnerabilities through the
48-
[PSModule security policy](https://github.com/PSModule/.github/blob/main/.github/SECURITY.md).
10+
- [Repository Standard](https://psmodule.io/Process-PSModule/reference/repository-standard/)
11+
- [PowerShell module standard](https://psmodule.io/Process-PSModule/reference/powershell-module-standard/)
12+
- [Validating before review](https://psmodule.io/Process-PSModule/guides/validating-before-review/)

AGENTS.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,10 @@
1-
# Agents
1+
# AGENTS
22

3-
## Main directive
3+
Read in this order:
44

5-
Everything is a work in progress and can be improved.
6-
If you find a problem or improvement, fix if small; otherwise open an issue.
7-
8-
## Repo guidance
9-
10-
- [`README.md`](README.md) — what this repository is and its purpose as a template.
11-
- [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md) — how to contribute to this repository.
12-
13-
## PSModule Framework guidance
14-
15-
Regarding repo structure, module source code and how the Process-PSModule workflow works.
16-
For PSModule-specific build, layout, and process guidance:
17-
18-
- [Template quickstart](https://psmodule.github.io/docs/Modules/Process-PSModule/template-quickstart/) — how to create a new module from this template.
19-
- [Repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) — the expected repository layout and required files.
20-
- [Module anatomy](https://psmodule.github.io/docs/Modules/Process-PSModule/module-anatomy/) — source layout and framework conventions.
21-
- [Build, test, pack, publish](https://psmodule.github.io/docs/Modules/Process-PSModule/build-test-pack-publish/) — the CI/CD pipeline.
22-
- [Standards](https://psmodule.github.io/docs/Modules/Standards/) — PowerShell module coding standards.
23-
- [PSModule/memory](https://github.com/PSModule/memory) — durable cross-session agent working memory for the PSModule organization.
24-
25-
## Org-wide guidance
26-
27-
For cross-cutting ways of working and standards:
28-
29-
- [Agentic Development](https://msxorg.github.io/docs/Ways-of-Working/Agentic-Development/) — how agents and humans collaborate in this ecosystem.
30-
- [Ways of Working](https://msxorg.github.io/docs/Ways-of-Working/) — contribution workflow, branching, PRs, issues.
31-
- [Coding Standards](https://msxorg.github.io/docs/Coding-Standards/) — language-level conventions.
32-
- [MSXOrg/memory](https://github.com/MSXOrg/memory) — durable agent working memory: gotchas, knowledge, and agent role notes.
5+
1. [`README.md`](README.md)
6+
- what this repository is and what it contains
7+
2. [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md)
8+
- how a change is made and reviewed
9+
3. [Process-PSModule documentation](https://psmodule.io/Process-PSModule/)
10+
- repository structure, module standards, and build/test/pack/publish guidance

0 commit comments

Comments
 (0)