Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (36 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 2.31 KB

Contributing to Microsoft.PowerShell.PlatyPS

This project follow the Microsoft Open Source Code of Conduct. By participating in this project, you agree to abide by its terms.

We welcome your contributions and suggestions.

Contributor License Agreement (CLA)

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For more information, see the Microsoft CLA.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA. If so, the bot will guide you through the process of signing the CLA.

Get started

There are several ways to contribute to this project:

  • Report issues: If you find a bug, please open an issue using the appropriate issue template.
  • Suggest features: If you have an idea for a new feature or improvement, please start a discussion in the GitHub discussions. When a feature request is approved, a maintainer will convert the discussion into an issue that can be the basis for a pull request.
  • Submit pull requests: If you want to contribute code, please fork the repository and submit a pull request. Pull requests should be based on the main branch and include a clear description of the changes you are proposing. Pull requests must be linked to an issue to be considered for merging.
  • Contribute to documentation: There are two kinds of documentation:
    • User documentation: This is the documentation that provide cmdlet reference and usage information. This documentation is published to Microsoft Learn and maintained in the MicrosoftDocs/PowerShell-Docs-Modules repository.
    • Developer documentation: This is the documentation aimed at contributors to the PlatyPS project. It is stored in the docs folder of this repository. For more information, see the README file in the docs folder.