Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

63 lines (47 loc) · 2.71 KB
Raw

Contributing to Windows Setup Scripts

Thank you for considering contributing to this project! Contributions are welcome and appreciated. Here are some guidelines to help you contribute effectively.

How to Contribute

1. Reporting Issues

If you encounter any issues or bugs while using this project, please report them by opening a GitHub issue. When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem, including steps to reproduce.
  • Information about your environment (e.g., Windows version, PowerShell version).
  • Any relevant log or error messages.

2. Suggesting Enhancements

We welcome suggestions for improving this project. To suggest an enhancement, please:

  • Open a GitHub issue with the tag "enhancement".
  • Describe your suggestion clearly and provide a rationale for the change.
  • Optionally, suggest how the enhancement could be implemented.

3. Submitting Pull Requests

If you'd like to contribute code to the project, follow these steps:

  1. Fork the repository:
    Fork the repository to your own GitHub account and clone it to your local machine.

  2. Create a branch:
    Create a new branch for your changes. The branch name should describe the change or fix, e.g., fix-log-output or add-winget-support.

    git checkout -b feature-or-fix-branch

  3. Make your changes:
    Implement your changes in the appropriate script(s). Ensure your code is clear, well-commented, and follows the existing style of the repository.

  4. Test your changes:
    Run the scripts to ensure your changes work as expected. If relevant, add tests or update documentation.

  5. Commit your changes:
    Commit your changes with a clear and concise commit message.

    git commit -m "Fix: Improve log handling in install.ps1"

  6. Push to your fork:
    Push your changes to your forked repository.

    git push origin feature-or-fix-branch

  7. Create a pull request:
    Submit a pull request to the main branch of this repository. Be sure to include a detailed description of your changes, referencing any relevant issues.

4. Code Style Guidelines

  • Follow PowerShell best practices and use clear, self-documenting code.
  • Use comments to explain the reasoning behind non-obvious code.
  • When adding new functionality, ensure that it's documented either in the code or the README.

5. License

By contributing to this project, you agree that your contributions will be licensed under the BSD 3-Clause License that covers this project.

Thank you for your contributions!