|
| 1 | +# Contributing to DeployWorkstation |
| 2 | + |
| 3 | +Thank you for your interest in contributing to DeployWorkstation! This document provides guidelines and information for contributors. |
| 4 | + |
| 5 | +## 🎯 Ways to Contribute |
| 6 | + |
| 7 | +### 🐛 Bug Reports |
| 8 | +- Use the bug report template |
| 9 | +- Include system information and logs |
| 10 | +- Provide clear reproduction steps |
| 11 | + |
| 12 | +### 💡 Feature Requests |
| 13 | +- Use the feature request template |
| 14 | +- Explain the use case and business value |
| 15 | +- Consider implementation complexity |
| 16 | + |
| 17 | +### 🔧 Code Contributions |
| 18 | +- Fork the repository |
| 19 | +- Create a feature branch |
| 20 | +- Follow PowerShell best practices |
| 21 | +- Add tests for new functionality |
| 22 | +- Update documentation |
| 23 | + |
| 24 | +### 📖 Documentation |
| 25 | +- Improve README clarity |
| 26 | +- Add configuration examples |
| 27 | +- Create troubleshooting guides |
| 28 | +- Fix typos and formatting |
| 29 | + |
| 30 | +## 🔄 Development Process |
| 31 | + |
| 32 | +### Setting Up Development Environment |
| 33 | +1. Fork the repository |
| 34 | +2. Clone your fork locally |
| 35 | +3. Create a feature branch: `git checkout -b feature/your-feature-name` |
| 36 | +4. Make your changes |
| 37 | +5. Test thoroughly on multiple Windows versions |
| 38 | +6. Commit with clear messages |
| 39 | +7. Push to your fork |
| 40 | +8. Create a pull request |
| 41 | + |
| 42 | +### PowerShell Style Guidelines |
| 43 | +- Use approved verbs for function names |
| 44 | +- Follow PascalCase for functions and variables |
| 45 | +- Use meaningful variable names |
| 46 | +- Include comment-based help for functions |
| 47 | +- Handle errors gracefully |
| 48 | +- Use Write-Log for consistent logging |
| 49 | + |
| 50 | +### Testing Requirements |
| 51 | +- Test on Windows 10 and 11 |
| 52 | +- Test both domain and workgroup environments |
| 53 | +- Verify offline functionality |
| 54 | +- Check with different hardware configurations |
| 55 | + |
| 56 | +## 📋 Code Review Process |
| 57 | + |
| 58 | +1. **Automated Checks**: PR must pass all automated tests |
| 59 | +2. **Manual Review**: Maintainer reviews code and functionality |
| 60 | +3. **Testing**: Changes tested in real deployment scenarios |
| 61 | +4. **Documentation**: Ensure documentation is updated |
| 62 | +5. **Approval**: Maintainer approves and merges PR |
| 63 | + |
| 64 | +## 🏷️ Commit Message Format |
| 65 | + |
| 66 | +## Use conventional commits format: |
| 67 | +Examples: |
| 68 | +type(scope): description |
| 69 | +feat(installer): add support for custom MSI packages |
| 70 | +fix(logging): resolve log file permission issues |
| 71 | +docs(readme): update installation instructions |
| 72 | +test(core): add unit tests for bloatware removal |
| 73 | + |
| 74 | +## 🔒 Security Issues |
| 75 | + |
| 76 | +For security-related issues: |
| 77 | +1. **DO NOT** open a public issue |
| 78 | +2. Email security@pnwcomputers.com |
| 79 | +3. Include proof of concept (if safe) |
| 80 | +4. Allow reasonable time for response |
| 81 | + |
| 82 | +## 📞 Getting Help |
| 83 | + |
| 84 | +- Check existing issues and documentation |
| 85 | +- Join discussions in GitHub Discussions |
| 86 | +- Email support@pnwcomputers.com for questions |
| 87 | + |
| 88 | +## 🙏 Recognition |
| 89 | + |
| 90 | +Contributors will be recognized in: |
| 91 | +- CHANGELOG.md for significant contributions |
| 92 | +- README.md for major features |
| 93 | +- GitHub contributors page |
| 94 | + |
| 95 | +Thank you for helping make DeployWorkstation better! |
| 96 | +EOF |
0 commit comments