Skip to content

Complete prerequisites#

Before you start contributing rules to PSRule for Azure, there are some required tools and recommended learning resources to help you get started.

Required tooling#

Using GitHub Codespaces#

If you have access to GitHub Codespaces, you can use it to contribute to PSRule for Azure. This allows you to work in a pre-configured environment without needing to set up your local machine. Otherwise you can follow the instructions below to set up your local development environment.

Set up your local development environment#

PSRule for Azure requires the following dependencies for development:

  • .NET SDK 8.0 — is used for building the project and core features.
  • PowerShell — is used for building the project, running the rules tests, and development of some rules.
  • Az PowerShell module — is used for exporting Azure resources and policies (in-flight).

To install development dependencies, refer to the installation guide.

Fork and clone the repository#

To start contributing, the first step is to fork the repository to your GitHub account and then clone it to your local machine.

  1. Fork the repository — Fork.
  2. Clone your fork — Once the repository is forked, clone it to your local machine.
Git
git clone https://github.com/YOUR_USERNAME/PSRule.Rules.Azure.git
cd PSRule.Rules.Azure

Understand the Project Structure#

Before you start contributing, it's helpful to understand the organization of the repository. Some of the most common sub-directories that are worth knowing about include:

Intro to Git and GitHub#

When contributing you'll need to have a GitHub account and a basic understanding of Git. Check out the links below to get started.