Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (17 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

21 lines (17 loc) · 1.17 KB

How to contribute

Contributing to PoshSec is a great way to give back to the community. We accept pull requests from anyone who submits one. There are a few guidelines, however, that a new pull request must adhere to before it is merged.

Adding functionality.

New features for PoshSec are added as individual .ps1 files and are grouped into the appropriate submodule of the main PoshSec module. A list of modules can be found in the PoshSec Wiki. Adding additional modules is possible but before you submit a pull request, add an issue for feedback from the maintainers. If you want immediate feedback, you can join the #PoshSec channel on FreeNode IRC and ask the question in there.

Getting Started

  • Make sure you have a Github account
  • PowerShell a version of PowerShell that is 3, 4 or 5
  • Fork the PoshSec Main Branch

Making Changes

  • Create a branch for your Changes
  • Make commits logical units
  • Make sure you have tests for your Changes
  • Make sure all the Pester tests still pass after your Changes
  • Submit a pull request when ready

Other notes

  • Make sure your code has help associated with it.
  • Be nice