Contributing to PowerShell Documentation

Welcome, Contributor!

Thank you for considering contributing to the PowerShell documentation. Your efforts help empower users worldwide to leverage the full potential of PowerShell. This guide outlines how you can get involved, from reporting issues to submitting new content.

Getting Started

The PowerShell documentation is hosted on GitHub. This means that contributions are managed through standard Git workflows.

1. Fork the Repository

Navigate to the official PowerShell documentation repository on GitHub and fork it to your own GitHub account. This creates a copy that you can freely modify.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/YOUR_USERNAME/PowerShell-Docs.git
cd PowerShell-Docs

3. Set Upstream Remote

Add the original repository as an upstream remote to pull in changes:

git remote add upstream https://github.com/PowerShell/PowerShell-Docs.git

Making Contributions

Reporting Issues

Found a typo, an error, or a section that could be clearer? Please open an issue in the GitHub repository. Be as specific as possible:

Describe the problem accurately.
Provide the URL of the affected page.
Suggest a fix if you have one.

Submitting Changes (Pull Requests)

For any changes, follow these steps:

Create a new branch: Always work on a separate branch for each contribution.
```
git checkout -b my-new-feature-or-fix
```
Make your changes: Edit existing content or add new articles. Ensure your content follows the documentation style guide.

Commit your changes:

git add .
git commit -m "Brief description of your changes"

Push to your fork:
```
git push origin my-new-feature-or-fix
```
Create a Pull Request: Go to your forked repository on GitHub and create a new Pull Request (PR) against the main branch of the original repository.

Important Note: Please ensure your changes are well-documented and that you adhere to the project's contribution guidelines.

Content Guidelines

When writing or editing documentation, please keep the following in mind:

Clarity and Conciseness: Write in clear, straightforward language. Avoid jargon where possible.
Accuracy: Ensure all code examples are correct and tested. Verify factual information.
Consistency: Follow the established style and formatting conventions.
Target Audience: Remember who you're writing for – from beginners to experienced users.

Code Examples

Use the provided markdown syntax for code blocks. Highlight PowerShell code for better readability.

# Example PowerShell command
Get-Process | Select-Object Name, CPU

Community and Support

If you have questions about contributing or the documentation itself, please engage with the PowerShell community:

We look forward to your contributions and appreciate your dedication to improving the PowerShell documentation!