Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 2.11 KB
Raw

Contributing

Thank you for contributing to this module. Read AGENTS.md first for the full guidance chain and documentation references.

Before you start

  1. Read README.md to understand what the module does.
  2. Familiarise yourself with the repository defaults that this repository must satisfy.
  3. Check the open issues and pull requests to avoid duplicate work.

Workflow

This project follows the MSXOrg contribution workflow:

  1. Open or pick up an issue that describes the change.
  2. Create a branch from main following the <type>/<issue>-<short-slug> convention (e.g. feat/42-add-security-md).
  3. Make small, focused commits and push often.
  4. Open a draft PR as soon as the change has a basic shape — early feedback is preferred.
  5. Run the Copilot review loop: request a Copilot review, address its feedback, and repeat until it reports a clean round. File an issue for any out-of-scope findings rather than expanding the PR.
  6. Mark the PR ready for review and enable auto-merge. It lands automatically once the required checks pass and a reviewer approves.

For branching details, see Branching and Merging.

Pull requests

  • Keep PRs small and focused on a single deliverable.
  • The PR title should follow the commit conventions.

For PR format guidance, see PR Format.

Issues

Use GitHub Issues to report bugs, request features, or propose improvements. Follow the issue format guidance.

Code standards

PowerShell in this module follows the PSModule Standards and the MSXOrg Coding Standards.

Questions

Open a GitHub Discussion or file an issue if something is unclear.