Thanks for considering a contribution to OSDCloud. This project welcomes fixes, documentation updates, and new features that improve Windows deployment workflows.
- Review the docs in docs to understand existing workflows.
- Check open issues to avoid duplicating work: https://github.com/OSDeploy/OSDCloud/issues
- Bug fixes with a clear repro and fix description
- Documentation improvements or missing details
- PowerShell cmdlets that align with the module's focus
- Fork the repository.
- Create a feature branch with a short, descriptive name.
- Make your changes and keep them focused on a single topic.
- Update or add documentation when behavior changes.
- Test in a Windows or WinPE environment when applicable.
- Open a pull request with a concise summary and any relevant context.
- Follow PowerShell best practices and approved verbs.
- Use clear, consistent naming and parameter design.
- Avoid aliases in scripts; use full cmdlet names.
- Keep user-facing output informative but minimal.
- Update README.md when user-facing behavior changes.
- Add or update docs in docs for new or changed commands.
By submitting a pull request or patch, you agree to assign all right, title, and interest in your contribution to Recast Software for inclusion in OSDCloud. You represent that the contribution is your original work or that you have the rights to submit it. If your employer or another party has rights to your work, you are responsible for obtaining any required permissions before contributing.
When opening an issue, include:
- What you expected to happen
- What actually happened
- Steps to reproduce
- PowerShell version and OS details
Be respectful and constructive. This project follows standard open-source collaboration norms.