Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.13 KB
Raw

Contributing

All contributions welcomed and are appreciated.

Module Conventions

PowerShell Styleguide

Use the standard Verb-Noun convention, and only use approved verbs.

All Functions must have Comment Based Help.

K&R (One True Brace Style variant) preffered.

Module Structure

The Functions directory structure is based on the of the structure official CyberArk WebServices CLI documentation). Any code exposing documented methods of the PACLI utility must exist in the folder relevant to the method area (UserManagement, safes, FoldersFiles etc.).

Any helper functions, consumed by other functions of the module must exist in the Private directory.

Contributing Code

  • Fork the repo.
  • Push your changes to your fork.
  • Ensure the modules Pester Tests pass.
  • Write a good commit message
  • Submit a pull request
    • Keep pull requests limited to a single issue
    • Discussion, or necessary changes may be needed before merging the contribution.