Skip to content

Commit ff43147

Browse files
authored
Update CONTRIBUTING.md
1 parent 15c507d commit ff43147

1 file changed

Lines changed: 26 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Thank you for your interest in contributing to DeployWorkstation! This document provides guidelines and information for contributors.
44

5+
## 📚 Table of Contents
6+
- [🎯 Ways to Contribute](#-ways-to-contribute)
7+
- [🔄 Development Process](#-development-process)
8+
- [📋 Code Review Process](#-code-review-process)
9+
- [🏷️ Commit Message Format](#-commit-message-format)
10+
- [🔒 Security Issues](#-security-issues)
11+
- [📞 Getting Help](#-getting-help)
12+
- [🙏 Recognition](#-recognition)
13+
514
## 🎯 Ways to Contribute
615

716
### 🐛 Bug Reports
@@ -52,6 +61,16 @@ Thank you for your interest in contributing to DeployWorkstation! This document
5261
- Test both domain and workgroup environments
5362
- Verify offline functionality
5463
- Check with different hardware configurations
64+
- Use virtual machines or sandbox environments when possible
65+
- Validate behavior with and without admin rights
66+
- Test with missing or partial Sysinternals tools to confirm graceful degradation
67+
68+
## ✅ Pull Request Checklist
69+
- [ ] Code follows PowerShell style guidelines
70+
- [ ] New functionality includes tests
71+
- [ ] Documentation is updated
72+
- [ ] Changes tested on Windows 10 and 11
73+
- [ ] No sensitive data included
5574

5675
## 📋 Code Review Process
5776

@@ -63,13 +82,13 @@ Thank you for your interest in contributing to DeployWorkstation! This document
6382

6483
## 🏷️ Commit Message Format
6584

66-
## Use conventional commits format:
85+
Use conventional commits format:
86+
6787
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
88+
- `feat(installer): add support for custom MSI packages`
89+
- `fix(logging): resolve log file permission issues`
90+
- `docs(readme): update installation instructions`
91+
- `test(core): add unit tests for bloatware removal`
7392

7493
## 🔒 Security Issues
7594

@@ -92,5 +111,4 @@ Contributors will be recognized in:
92111
- README.md for major features
93112
- GitHub contributors page
94113

95-
Thank you for helping make DeployWorkstation better!
96-
EOF
114+
We’re excited to collaborate with you! Whether it’s a typo fix or a new feature, your contribution makes a difference.

0 commit comments

Comments
 (0)