Issue Tracking & Templates
Relevant source files
The following files were used as context for generating this wiki page:
Issue tracking in the Kuberhealthy project serves as the primary mechanism for community communication, feature planning, and bug reporting. It ensures that all technical changes—ranging from minor bug fixes to architectural shifts—are documented, discussed, and aligned with project standards before implementation.
The project utilizes structured templates to standardize the information provided by contributors. This standardization facilitates faster triage by maintainers and ensures that all necessary technical context, such as environment details for bugs or design considerations for proposals, is captured at the point of creation.
Sources: CONTRIBUTING.md, README.md
Standard Issue Types
Kuberhealthy categorizes community input into three primary streams: Bugs, Feature Requests, and Proposals. Each stream has a specific workflow and required information set.
Bug Reporting
Bug reports are used to document reproducible errors or unexpected behavior in the Kuberhealthy operator or its checks. Contributors are required to provide the version of Kuberhealthy being used and a clear description of the issue.
Sources: .github/ISSUE_TEMPLATE/bug.md
Feature Requests
Feature requests allow users to suggest improvements or new synthetic checks. The template focuses on the "what" and "why," requiring a description of the desired behavior and the problem the feature would solve.
Sources: .github/ISSUE_TEMPLATE/feature-request.md
Proposals
Proposals are mandatory for large changes to the project. They serve as a safeguard to ensure that significant work is not denied after development has already begun. A proposal issue should be submitted and discussed before a contributor opens a Pull Request for a large feature.
Sources: CONTRIBUTING.md:12-13, .github/ISSUE_TEMPLATE/proposal.md
Issue Workflow and Lifecycle
The workflow for an issue typically moves from submission to maintainer review and finally to implementation via a Pull Request.
The diagram above illustrates the path from initial user identification of a problem or need to the eventual merge of code into the master branch.
Sources: CONTRIBUTING.md:12-21
Template Technical Specifications
The following table summarizes the required fields and metadata for each issue type as defined in the project configuration.
| Issue Type | Template File | Metadata Labels | Key Required Fields |
|---|---|---|---|
| Bug | bug.md | kind/bug | Kuberhealthy version, Description |
| Feature Request | feature-request.md | kind/feature | Description, Problem solved |
| Proposal | proposal.md | kind/proposal | High-level overview, Design details |
Sources: .github/ISSUE_TEMPLATE/bug.md, .github/ISSUE_TEMPLATE/feature-request.md, .github/ISSUE_TEMPLATE/proposal.md
Community Standards and Enforcement
All issue tracking and subsequent discussions are governed by the project's Code of Conduct and contributing guidelines.
Code of Conduct
Project maintainers have the authority and responsibility to remove, edit, or reject issues and comments that do not align with the project's standards of respect and professionalism. This includes the ability to ban contributors for inappropriate behavior.
Sources: CODE_OF_CONDUCT.md:28-33
General Requirements for Resolution
For an issue to be resolved and merged via a Pull Request, the following technical requirements must be met:
- Commits must be signed using
git commit -s(DCO compliance). - Code must be formatted with
go fmt. - New functionality must include corresponding tests.
- All Github CI tests must pass.
Sources: CONTRIBUTING.md:4-6, CONTRIBUTING.md:23-26
Summary
Issue tracking in Kuberhealthy is a structured process designed to balance open community contribution with maintainer oversight. By requiring templates for bugs and feature requests, and mandatory proposal issues for large-scale changes, the project ensures that development efforts are technically sound and community-aligned before code is committed to the master branch. All interactions within the issue tracker are bound by the project's Code of Conduct to maintain a collaborative environment.