Thank you for your interest in contributing to this project!
Please abide by the Code of Conduct for all interactions with this repository.
Pull requests are the mechanism you can use to submit your PowerShell Scanners to this repository. GitHub itself has some great documentation on using the Pull Request feature. We use the "fork and pull" model described here, where contributors push changes to their personal fork and create pull requests to bring those changes into the source repository.
Please follow the Style Guide when crafting your pull request.
All pull requests are reviewed by a PDQ.com employee. We'll try to get to your pull request as soon as we can, but please be patient.
Each scanner gets its own folder. Give your folder a descriptive name. These are the expected files:
- Scan Profile.xml
- This is a Scan Profile exported from Inventory as an XML file. It points to your .ps1 file with the File field.
- "Script".ps1
- Replace "Script" with the same name you used for your folder.
- README.md
- Put in as much detail as you think is necessary. Look at the other scanners for ideas.
You can use New-Scanner.ps1 in the PowerShell Scanners folder to create these files for you.
Set-Location 'C:\PowerShell-Scanners\PowerShell Scanners'
.\New-Scanner.ps1 -Name 'Your desired name'If you discover a bug, please search existing issues to see if it has already been reported.
When you file your issue, please be as descriptive as possible. This helps other people search for your issue, and it helps us find and fix the issue as quickly as possible. Screenshots can be very helpful too!