Contributing Docs

[soulemike]

A discussion was raised in Discord on how to contribute. There are a few considerations:

• Core module
• Tests
• GitHub Action

[soulemike]

Tests

There are 3 major components to each test.

1. Markdown file that represents the details shown for each test in the report. E.g. https://github.com/maester365/maester/blob/main/powershell/public/cisa/exchange/Test-MtCisaDkim.md
2. PowerShell cmdlet file that represents the specific logic for a given test or multiple tests. E.g. https://github.com/maester365/maester/blob/main/powershell/public/cisa/exchange/Test-MtCisaDkim.ps1
3. Pester test file that calls the corresponding PowerShell cmdlet during an execution of the Maester tests. E.g. https://github.com/maester365/maester/blob/main/tests/cisa/exchange/Test-MtCisaDkim.Tests.ps1

https://maester.dev/docs/writing-tests/

[fflaten]

Getting started: https://maester.dev/docs/contributing