Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 920 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 920 Bytes

Contribution Guidelines

This document aims to outline the requirements for the various forms of contribution for this project.

ALL contributions are subject to review via pull request

New Functions

  • Update the "Unreleased" section of the changelog to reflect what was added
  • Use approved Powershell verbs for function names
  • Include Comment Based Help for every function
  • Update the module version number and include the new function in the FunctionsToExport in UofIQualys.psd1
  • Markdown documentation must be placed in the module's docs folder

Function Enhancements

  • Issue justifying the change should be created and cited in the pull request
  • Update the changelog to reflect the change
  • Increment the version number appropriately, there is no proper release for this so it is incremented as it's updated

Documentation

  • Must be in markdown