Contributing

KubeGlass is open source and welcomes contributions of all kinds - code, documentation, bug reports, feature requests, and community support.

Quick Links

Contributing Guide Development setup, coding standards, and PR workflow.

Code of Conduct Our community standards and enforcement policy.

Security Policy How to report security vulnerabilities responsibly.

Governance Project roles, decision-making, and maintainer path.

Ways to Contribute

Report bugs

Open an issue with:

• KubeGlass version (kubeglass --version)
• Kubernetes version and distribution
• Steps to reproduce
• The requestId from any error response

Suggest features

Start a GitHub Discussion to propose ideas before opening a PR. This helps align on design and avoids wasted effort.

Submit code

1. Fork the repository
2. Create a feature branch from main
3. Write tests (80% coverage minimum for both Go and TypeScript)
4. Run make check to validate lint, typecheck, and tests
5. Open a pull request with a clear description

All commits must be signed off (git commit -s) per the DCO.

Improve documentation

Documentation lives in two places:

• Docs site (you’re reading it) - docs-site/src/content/docs/
• Repo docs - README.md, ARCHITECTURE.md, docs/

Edit links appear at the bottom of every docs page.

Development Setup

# Clone and install
git clone https://github.com/kubeglass/kubeglass.git
cd kubeglass

# Backend (Go 1.25+)
make dev

# Frontend (Node 22+)
cd web && npm install && npm run dev

# Run everything
make dev-all

# Run all checks before committing
make check

See the Contributing Guide for the full development workflow.

Maintainers

Name	GitHub	Role
Kisan Shah	@kisanity	Lead Maintainer

See MAINTAINERS.md for the complete list and GOVERNANCE.md for how to become a maintainer.