Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (74 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

100 lines (74 loc) · 2.82 KB

🚀 Contributing to PowerSetSetup

Thank you for considering contributing to PowerSetSetup! This document provides guidelines and steps for contributing.

📋 Table of Contents

🛠 How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the repository page.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/PowerSetSetup.git
cd PowerSetSetup

3. Create a Feature Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

  • Keep changes focused and atomic
  • Test thoroughly on Windows 10/11
  • Update documentation if needed

5. Commit Your Changes

git commit -m "Add: brief description of your changes"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Submit a Pull Request

Open a Pull Request from your branch to the main repository.

💻 Development Setup

Requirements:

  • Windows 10/11 (primary platform)
  • Command Prompt or PowerShell
  • Basic knowledge of batch scripting

Testing:

  • Test your changes on multiple Windows versions if possible
  • Ensure no breaking changes to existing functionality
  • Verify error handling works correctly

📝 Coding Guidelines

Style:

  • Follow existing code structure and naming conventions
  • Use clear variable names (English recommended)
  • Add comments for complex logic

Best Practices:

  • Error Handling: Check errorlevel after critical commands
  • User Experience: Provide clear messages and instructions

🔄 Pull Request Process

Before Submitting:

  1. ✅ Ensure code follows project style
  2. ✅ Test on Windows 10 and 11
  3. ✅ Update documentation if required
  4. ✅ Check for any linting issues

PR Requirements:

  • Clear Title: Describe what the PR does
  • Detailed Description: Explain changes and motivation
  • Testing Information: Describe how you tested
  • Screenshots: If applicable for UI changes

Review Process:

  1. Maintainers will review your PR
  2. Address any requested changes
  3. Once approved, your PR will be merged

❓ Need Help?

🌟 Recognition

All contributors will be recognized in the project's README and release notes!

Thank you for making PowerSetSetup better! 💙