|
1 | 1 | # Contributing |
2 | 2 |
|
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. |
7 | 7 |
|
8 | | -## Before you start |
| 8 | +Use the Process-PSModule documentation for repository-specific standards: |
9 | 9 |
|
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/) |
0 commit comments