Thank you for considering contributing to PC Setup Scripts!
- Check if the issue already exists
- Include your OS version
- Provide error messages and logs
- Describe steps to reproduce
- Clearly describe the enhancement
- Explain why it would be useful
- Provide examples if applicable
- Fork the repository
- Create a feature branch (
git checkout -b feature/your-feature) - Make your changes
- Test thoroughly on your system
- Commit with clear messages (
git commit -m 'Add feature: description') - Push to your fork (
git push origin feature/your-feature) - Open a Pull Request
- Use meaningful variable names
- Add comments for complex logic
- Include error handling with try/catch
- Test on Windows 10 and 11
- Follow consistent formatting
- Use shellcheck to validate
- Include shebang (
#!/bin/bash) - Add comments for clarity
- Test on multiple macOS versions
When adding packages:
- Verify the package exists in Chocolatey/Homebrew
- Add to the appropriate alphabetical position
- Include package name in README if significant
- Test installation on clean system
- Update README.md for new features
- Keep documentation clear and concise
- Include usage examples
- Update version information
- Test scripts on fresh installations when possible
- Verify packages install correctly
- Check for conflicts with existing software
- Test error handling
Open an issue for any questions or clarifications needed.
Thank you for contributing! 🎉