Contributing¶

Thank you for your interest in contributing to KubeAuto! This guide explains how to get involved.

Ways to Contribute¶

• 🐛 Report bugs — open a GitHub Issue
• 💡 Request features — describe your idea in a GitHub Issue
• 📝 Improve documentation — fix typos, add examples, clarify instructions
• 🔧 Submit code — fix bugs or implement new features via Pull Requests

Development Setup¶

1. Fork the repository on GitHub
2. Clone your fork:

   git clone https://github.com/<your-username>/kubeadm-automation.git
   cd kubeadm-automation
   

3. Create a feature branch:

   git checkout -b feature/your-feature-name
   

4. Make your changes
5. Commit following the Conventional Commits format
6. Push and open a Pull Request against the develop branch

Branch Naming¶

Commit Messages¶

We use Conventional Commits:

<type>(<scope>): <short description>

Examples¶

feat(cluster): add pinned kubernetes_version field to cluster.yaml
fix(worker): handle expired join token on vagrant up after halt
docs(readme): add architecture diagram
chore(ci): add shellcheck to lint workflow

Pull Request Guidelines¶

1. Target the develop branch (not main)
2. Write a clear description of what changed and why
3. Ensure your changes don't break existing functionality
4. Follow the commit message convention
5. Keep PRs focused — one feature or fix per PR

Code Style¶

Shell Scripts¶

• Use #!/usr/bin/env bash
• Enable strict mode: set -euo pipefail
• Use meaningful variable names
• Add comments for non-obvious logic

YAML¶

• Use 2-space indentation
• Quote string values
• Add comments for configuration sections

Questions?¶

Open an issue or start a discussion on the GitHub repository.