Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (31 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.55 KB
Raw

Contributing to ITAdmin_Tools

Thanks for your interest in contributing! This repo hosts PowerShell modules published to the PowerShell Gallery. Here's how you can help.

Ways to contribute

  • Bug reports — Use the Bug Report issue template
  • Feature requests — Use the Feature Request issue template
  • Code improvements — Fork, make changes on a new branch, and open a pull request
  • Documentation — Improve README files, add inline help to functions, or fix typos

Getting started

  1. Fork this repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/ITAdmin_Tools.git
  3. Create a new branch: git checkout -b fix/your-fix-name
  4. Make your changes and test them locally
  5. Commit with a descriptive message: git commit -m "fix: describe what you fixed"
  6. Push to your fork: git push origin fix/your-fix-name
  7. Open a Pull Request against the main branch

Code style

  • Follow PowerShell best practices and use approved verbs (Get-Verb)
  • Add comment-based help (.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE) to all public functions
  • Test your changes in PowerShell 5.1 and 7.x where possible
  • Keep functions focused — one function, one responsibility

Pull request guidelines

  • Describe what the PR does and why
  • Reference related issues (e.g. Closes #12)
  • Keep PRs small and focused — one fix or feature per PR

Questions?

Open an issue or reach out via pwsh.in.