Skip to content

Commit 4bdd84e

Browse files
brazilianscriptguybrazilianscriptguy
authored
Update CONTRIBUTING.md
Signed-off-by: LUIZ HAMILTON ROBERTO DA SILVA <[email protected]>
1 parent c41c833 commit 4bdd84e

1 file changed

Lines changed: 124 additions & 94 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 124 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,124 @@
1-
<div>
2-
<h1>🤝 Contributing to PowerShell ToolSet for Windows Server Administration and VBScript Repository</h1>
3-
<p>
4-
Thank you for considering contributing to this project! Contributions are welcome and appreciated. By following these guidelines, you help ensure the project remains high-quality, maintainable, and useful for all users.
5-
</p>
6-
7-
<h2>📝 How to Contribute</h2>
8-
9-
<h3>1. 🐞 Reporting Issues</h3>
10-
<ul>
11-
<li>
12-
<strong>Bug Reports:</strong> Use the <strong>Bug report</strong> template to report issues. Include steps to reproduce, system environment, and logs or screenshots when possible.
13-
</li>
14-
<li>
15-
<strong>Feature Requests:</strong> Use the <strong>Feature request</strong> template to suggest improvements or new ideas. Please be specific and explain how the feature adds value.
16-
</li>
17-
</ul>
18-
19-
<h3>2. 🔀 Submitting Pull Requests</h3>
20-
<ul>
21-
<li><strong>Fork the Repository:</strong> Fork it to your GitHub account.</li>
22-
<li><strong>Create a Branch:</strong> Use a descriptive branch name like <code>feature/add-new-tool</code> or <code>bugfix/remove-legacy-code</code>.</li>
23-
<li><strong>Make Changes:</strong> Keep your code modular, clean, and follow existing conventions.</li>
24-
<li><strong>Test Changes:</strong> Ensure your script works as intended and doesn't break other functions.</li>
25-
<li><strong>Submit PR:</strong> Target your pull request to the <code>main</code> branch and provide a clear explanation of the changes.</li>
26-
</ul>
27-
28-
<h3>3. 💻 Coding Standards</h3>
29-
<ul>
30-
<li><strong>Style Consistency:</strong> Match the indentation, casing, and layout style already used.</li>
31-
<li><strong>Comments:</strong> Use meaningful comments to explain non-obvious logic and structures.</li>
32-
<li><strong>Commits:</strong> Write clear and meaningful commit messages that describe the "what" and "why" of your changes.</li>
33-
</ul>
34-
35-
<h3>4. ✨ Guidelines for New Features</h3>
36-
<ul>
37-
<li><strong>Project Alignment:</strong> Features must align with Windows Server and workstation management objectives.</li>
38-
<li><strong>No Breaking Changes:</strong> Maintain compatibility with existing scripts and usage where possible.</li>
39-
</ul>
40-
41-
<h3>5. 👤 Communication</h3>
42-
<ul>
43-
<li><strong>Respect:</strong> Be courteous, inclusive, and constructive in all interactions.</li>
44-
<li><strong>Open Questions:</strong> Raise questions by opening issues or joining ongoing discussions.</li>
45-
</ul>
46-
47-
<h2>📚 Additional Resources</h2>
48-
<ul>
49-
<li>
50-
<strong>📜 Code of Conduct:</strong> Read our
51-
<a href="https://github.com/brazilianscriptguy/Windows-SysAdmin-ProSuite/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank">Code of Conduct</a>
52-
to understand the standards of behavior.
53-
</li>
54-
<li>
55-
<strong>📖 Getting Started:</strong> Review the
56-
<a href="https://github.com/brazilianscriptguy/Windows-SysAdmin-ProSuite/tree/main" target="_blank">README.md</a>
57-
for project structure and module details.
58-
</li>
59-
</ul>
60-
61-
<hr />
62-
63-
<h2>🗂️ Version History</h2>
64-
<table border="1" style="border-collapse: collapse; width: 100%;">
65-
<thead>
66-
<tr>
67-
<th>Version</th>
68-
<th>Date</th>
69-
<th>Changes Made</th>
70-
<th>Author</th>
71-
</tr>
72-
</thead>
73-
<tbody>
74-
<tr>
75-
<td>1.0</td>
76-
<td>2023-01-01</td>
77-
<td>Initial creation</td>
78-
<td>Luiz Hamilton Silva</td>
79-
</tr>
80-
<tr>
81-
<td>1.1</td>
82-
<td>2023-06-15</td>
83-
<td>Added Core-ScriptLibrary and ITSM-Templates</td>
84-
<td>Luiz Hamilton Silva</td>
85-
</tr>
86-
<tr>
87-
<td>1.2</td>
88-
<td>2024-04-27</td>
89-
<td>Updated Supported Versions tables and links</td>
90-
<td>Luiz Hamilton Silva</td>
91-
</tr>
92-
</tbody>
93-
</table>
94-
</div>
1+
# 🤝 Contributing to Windows SysAdmin ProSuite
2+
3+
Thank you for your interest in contributing to **Windows SysAdmin ProSuite**.
4+
This repository contains **enterprise-grade PowerShell and VBScript automation tools** focused on Windows Server, Active Directory, ITSM workflows, and security operations.
5+
6+
Contributions are welcome and appreciated, provided they follow the guidelines below.
7+
8+
---
9+
10+
## 📝 Ways to Contribute
11+
12+
### 🐞 Reporting Bugs
13+
All issues **must** be submitted using the GitHub Issue Forms.
14+
15+
- Use **Bug Report** for defects, errors, or unexpected behavior
16+
- Provide:
17+
- Clear reproduction steps
18+
- Expected vs actual behavior
19+
- Environment details (OS, PowerShell version, tool path)
20+
- Logs or screenshots when applicable
21+
22+
👉 Issue forms automatically apply labels and ensure consistent structure.
23+
24+
---
25+
26+
### ✨ Requesting Features
27+
Use the **Feature Request** issue form when proposing enhancements.
28+
29+
Please include:
30+
- The problem being solved
31+
- The proposed solution
32+
- Alternatives considered
33+
- Expected impact or benefit
34+
35+
Feature requests should align with:
36+
- Windows Server administration
37+
- Active Directory / IAM
38+
- ITSM automation
39+
- Security and compliance tooling
40+
41+
---
42+
43+
### 🔀 Submitting Pull Requests
44+
45+
#### 1. Fork & Branch
46+
- Fork the repository
47+
- Create a branch from `main`
48+
- Use descriptive branch names:
49+
- `feature/add-dhcp-tool`
50+
- `bugfix/fix-null-check`
51+
- `docs/update-readme`
52+
53+
#### 2. Development Rules
54+
- Follow existing folder structure
55+
- Do **not** mix unrelated changes in a single PR
56+
- Do **not** modify version numbers inside PRs
57+
58+
#### 3. Coding Standards (Mandatory)
59+
60+
**PowerShell**
61+
- 4-space indentation
62+
- No `Write-Host`
63+
- Comment-based help headers required
64+
- Compatible with PowerShell 5.1+
65+
- Logging to `C:\Logs-TEMP`
66+
- No breaking changes without discussion
67+
68+
**Linting / Formatting**
69+
- PSScriptAnalyzer rules enforced
70+
- Prettier formatting for Markdown, YAML, JSON
71+
- CI must pass before review
72+
73+
#### 4. Testing
74+
Before submitting:
75+
- Test scripts locally
76+
- Validate GUI behavior if applicable
77+
- Ensure no regressions are introduced
78+
79+
#### 5. Submit the PR
80+
- Target the `main` branch
81+
- Clearly describe:
82+
- What was changed
83+
- Why it was changed
84+
- Any limitations or follow-ups
85+
86+
---
87+
88+
## ☑️ Pull Request Checklist
89+
90+
Before submitting, confirm:
91+
92+
- [ ] Code follows repository standards
93+
- [ ] Scripts were tested locally
94+
- [ ] No unrelated files were modified
95+
- [ ] Documentation updated when needed
96+
- [ ] No new warnings or errors introduced
97+
- [ ] CI checks pass
98+
99+
---
100+
101+
## 💬 Communication & Conduct
102+
103+
- Be respectful and constructive
104+
- Keep discussions technical and objective
105+
- Use Issues for questions or clarifications
106+
107+
Please read the **Code of Conduct** before contributing.
108+
109+
---
110+
111+
## 📚 Useful Links
112+
113+
- 📄 **README:**
114+
https://github.com/brazilianscriptguy/Windows-SysAdmin-ProSuite
115+
116+
- 📜 **Code of Conduct:**
117+
https://github.com/brazilianscriptguy/Windows-SysAdmin-ProSuite/blob/main/.github/CODE_OF_CONDUCT.md
118+
119+
- 🔐 **Security Policy:**
120+
https://github.com/brazilianscriptguy/Windows-SysAdmin-ProSuite/blob/main/.github/SECURITY.md
121+
122+
---
123+
124+
Thank you for helping improve **Windows SysAdmin ProSuite** 🚀

0 commit comments

Comments
 (0)