Skip to content

Process overview#

This article describes the process for contributing to PSRule for Azure based on the type of contribution you want to make. Anyone can contribute to PSRule for Azure, whether you are a new or experienced user.

Contributing rules#

To contribute new or updated rules to PSRule for Azure, follow these steps:

  1. Complete prerequisites — Ensure you have the required tools and knowledge to contribute.
  2. Create or assign an issue — Use this issue to track and discuss your contribution.
  3. Choose identifiers — Assign unique identifiers to the rule you are contributing.
  4. Create or update a rule — Write the rule code in YAML or PowerShell.
  5. Testing a rule — Write unit tests to ensure the rule works as expected.
  6. Add rule help — Write help documentation for the rule in markdown.
  7. Update the change log — Update the change log to reflect your changes.
  8. Submit a pull request — Submit your changes for review and merge into the main branch.

Comments