Thank you for your interest in contributing to our Ansible roles! This document provides guidelines for contributing to any of our ansible-role-* repositories.
- Fork the repository you want to contribute to
- Create a feature branch from
main - Make your changes following our guidelines below
- Test your changes thoroughly
- Submit a pull request
- Follow Ansible best practices
- Use descriptive variable names
- Include comments for complex logic
- Maintain consistent indentation (2 spaces for YAML)
- Use conventional commit format:
type(scope): description - Types:
feat,fix,docs,style,refactor,test,chore - Keep the first line under 72 characters
- Include detailed description if needed
- Test on supported platforms listed in
meta/main.yml - Ensure all existing tests continue to pass
- Add tests for new functionality when applicable
- Update README.md if adding new features
- Document all variables in
defaults/main.yml - Include usage examples where helpful
Please use our issue templates when reporting bugs or requesting features. Provide as much detail as possible including:
- Operating system and version
- Ansible version
- Role configuration
- Error messages and logs
- Email: dominik@lenhardt-it.com
- Website: https://lenhardt-it.com
All our Ansible roles are licensed under the MIT License. By contributing, you agree that your contributions will be licensed under the same license.