Skip to content

CONTRIBUTING_TO_Powershell-Scripts.md

Latest commit

 

History

History
46 lines (30 loc) · 2.3 KB

CONTRIBUTING_TO_Powershell-Scripts.md

File metadata and controls

46 lines (30 loc) · 2.3 KB

Contributing Guidelines

Thank you for considering contributing to the PowerShell Scripts project on Reddit! We welcome your contributions and appreciate your interest in helping improve our scripts. Please take a moment to review these guidelines to ensure a smooth and collaborative contribution process.

Code of Conduct

Please review our (https://github.com/meanstackofdoom/Powershell-Scripts/blob/main/CODE_OF_CONDUCT.md) before participating. We expect all contributors to adhere to it to create a friendly and inclusive environment.

Reporting Issues

If you encounter a bug, have a feature request, or have any questions about the project, please open an issue on our https://github.com/meanstackofdoom/Powershell-Scripts/ When reporting issues, please provide as much detail as possible, including:

  • A clear and concise description of the problem.
  • Steps to reproduce the issue.
  • The PowerShell version you're using.
  • Any relevant error messages or logs.

Contributing Code

  1. Fork the repository to your GitHub account.
  2. Clone your fork to your local development environment.
  3. Create a new branch for your changes.
  4. Make your changes and commit them with clear and concise commit messages.
  5. Push your changes to your fork on GitHub.
  6. Create a pull request (PR) from your fork's branch to the main repository's branch.
    • Clearly describe your changes and their purpose in the PR description.
    • Reference any related issues in your PR description using keywords like "Closes #123" to automatically close the issue when the PR is merged.
  7. Participate in the code review process, address feedback, and make any necessary updates.

Style Guidelines

Please follow these style guidelines when contributing to ensure consistency in the project:

  • Use meaningful variable and function names.
  • Write clear and concise comments to explain complex logic or non-obvious behavior.
  • Format your code following PowerShell best practices.

Testing

Ensure your changes pass any existing tests and add new tests if necessary to cover your code.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for contributing to the PowerShell Scripts project on Reddit! Your contributions help make this project better for everyone.