Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (53 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

80 lines (53 loc) · 3.55 KB

Contributing to StageCoder

You are more than welcome to contribute to the StageCoder module, whether it is Pull Requests, Feature Suggestions or Bug Reports!

Getting Started

  • Fork this repo (see this forking guide for more information).
  • Checkout the repo locally with git clone [email protected]:{your_username}/StageCoder-PowerShell.git.
  • If you haven't already, you will need the PlatyPs PowerShell Module to generate command help and docs.

Developing

Structure

The repo is organized as below:

  • Private (Src/Private): All private functions used by the module.
  • Public (Src/Public): All functions exported by the module.
  • Tests (Tests): Pester tests executed at Pull Request.
  • Help (Docs/Help): Markdown help files for external help.

Running the module locally

  • Import the module:
Import-Module ./Src/StageCoder.psd1

platyPS

platyPS is used to write the external help in markdown. When contributing always make sure that the changes are added to the help file.

Quickstart

Install-Module -Name platyPS -Scope CurrentUser
Import-Module platyPS
  • Create initial Markdown help file for StageCoder module (This will only create help files for new commands, existing files will not be overwritten):
# you should have module imported in the session
Import-Module './Src/StageCoder.psd1'
New-MarkdownHelp -Command 'My-NewCommand' -OutputFolder './Docs/Help'

Edit the markdown file(s) in the ./Docs/Help folder and populate {{ ... }} placeholders with missed help content.

  • If you've made a lot of changes to the module code, you can easily update the markdown file(s) automatically with:
# re-import your module with latest changes
Import-Module './Src/StageCoder.psd1' -Force
Update-MarkdownHelp './Docs/Help'

Pull Requests

If you like to start contributing to the StageCoder module. Please make sure that there is a related issue to link to your PR.

  • Make sure that the issue is tagged in the PR, e.g. "fixes #45"
  • Write a short but informative commit message, it will be added to the release notes.

Feature Suggestions

  • Please first search Open Issues before opening an issue to check whether your feature has already been suggested. If it has, feel free to add your own comments to the existing issue.
  • Ensure you have included a "What?" - what your feature entails, being as specific as possible, and giving mocked-up syntax examples where possible.
  • Ensure you have included a "Why?" - what the benefit of including this feature will be.
  • Use the "Feature Request" issue template here to submit your request.

Bug Reports

  • Please first search Open Issues before opening an issue, to see if it has already been reported.
  • Try to be as specific as possible, including the version of the ADOPS PowerShell module, PowerShell version and OS used to reproduce the issue, and any example files or snippets of ADOPS code needed to reproduce it.
  • Use the "Bug Report" issue template here to submit your request.