Skip to content

How to contribute

Ways to contribute to KubePeep: code, documentation, testing and more.

Contributions are welcome in many areas:

  • Development — fixes and features in the Go core and interface.
  • Interface and user experience — usability, accessibility and design.
  • Documentation — corrections, new guides and translations.
  • Tests — test cases, environments and behavior reports.
  • Bug reports — issues with context and reproduction steps.
  • Feature requests — discussions with concrete use cases.
  • Security — responsible reporting via security policy.

Contribution workflow

  1. Fork the official repository: github.com/fvmoraes/kubepeep.
  2. Create a descriptive branch from main.
  3. Set up your development environment using repository instructions.
  4. Make changes with tests where appropriate.
  5. Open a pull request describing the motivation and changes.

The definitive development guide, including builds, tests and conventions, lives in the application repository. See the README.md and the documentation for docs/ of the project.

Reporting bugs

When reporting a bug, include:

  • KubePeep version (kubePeep version, or kubepeep version in Linux packages).
  • Operating system and architecture.
  • Sanitized output of kubePeep doctor without sensitive data (never include kubeconfig, tokens or cluster details).
  • Reproduction steps and expected versus actual behavior.

Code of conduct

All project spaces follow the Code of Conduct.

This site

This site also welcomes text corrections, accessibility improvements and documentation updates. See Contribute for details.