Contributing
Thank you for considering a contribution! We welcome bug reports, feature requests, code, docs, and suggestions.
Dependencies
Section titled “Dependencies”- Go
- Docker (or supported runtime)
- Trivy / Grype (optional)
- golangci-lint
Getting Started
Section titled “Getting Started”-
Fork the repository on GitHub
-
Clone your fork:
git clone <your-fork-url> -
Create a branch from
dev:git checkout -b feat/my-feature dev -
Make your changes, format with
gofmt -w .and lint withgolangci-lint run -
Open a PR targeting the
devbranch
Branch Naming
Section titled “Branch Naming”| Type | Format |
|---|---|
| Feature | feat/description |
| Bug fix | bug/#issue-number |
| Docs | docs/description |
Commit Messages
Section titled “Commit Messages”Follow the format <type>: <description>:
feat: add podman runtime supportbug: fix container stop keybinddocs: update keybinds referenceIssues
Section titled “Issues”- Search open and closed issues before opening a new one
- For bugs: include OS, runtime version, logs, and reproduction steps
- For features: describe the problem and your proposed solution
Pull Requests
Section titled “Pull Requests”- One change per PR
- Link the relevant issue
- Respond to reviewer comments promptly
Questions?
Section titled “Questions?”Use GitHub Discussions or open an issue with the question label.
All contributors are credited in the repository. Thank you!