Skip to content

CONTRIBUTING.MD

Latest commit

 

History

History
98 lines (67 loc) · 3.15 KB

CONTRIBUTING.MD

File metadata and controls

98 lines (67 loc) · 3.15 KB

Contributing to slmgr-ps

Thank you for considering contributing to our project! Your help is greatly appreciated. This document provides guidelines for contributing to the development and maintenance of the module.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Coding Guidelines
  4. Additional Resources

Getting Started

To get started with contributing, please ensure you have the following setup:

  • Install Git
  • Install PowerShell 7
  • Fork the repository on GitHub and clone it to your local machine.
git clone https://github.com/zbalkan/slmgr-ps.git
cd slmgr-ps

How to Contribute

Reporting Bugs

If you encounter any bugs, please open an issue on GitHub with the following information:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the issue
  • Expected and actual results
  • Any relevant logs or error messages

Suggesting Enhancements

We welcome feature requests and suggestions for improvements. Please open an issue on GitHub with the following details:

  • A clear and descriptive title
  • A detailed description of the enhancement or feature request
  • Any relevant use cases or examples

Submitting Pull Requests

When you're ready to contribute code, follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your feature or bugfix.
git checkout -b feature/your-feature-name
  1. Implement your changes, ensuring adherence to the coding guidelines.
  2. Test your changes thoroughly.
  3. Commit your changes with a descriptive commit message.
  4. Push your branch to your forked repository.
git push origin feature/your-feature-name
  1. Open a pull request against the main repository.

Coding Guidelines

Code Style

We follow the official Microsoft PowerShell style guide. Key points include:

  • Use camelCase for variable names.
  • Use PascalCase for function and cmdlet names.
  • Use 4 spaces for indentation.
  • Ensure all scripts are UTF-8 encoded.

For detailed guidelines, refer to the PowerShell Best Practices and Style Guide.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Capitalize the first letter of the subject line.
  • Keep the subject line under 50 characters.
  • Include a detailed description of the changes in the body of the message if necessary.

Additional Resources

By following these guidelines, you'll help ensure that the project remains consistent and maintainable. Thank you for your contributions!