Skip to content

feat(.github): add structured issue templates for bug reports and feature requests#516

Merged
paigerube14 merged 3 commits into
krkn-chaos:mainfrom
Rajeevydvv:feat/github-issue-templates
Jul 13, 2026
Merged

feat(.github): add structured issue templates for bug reports and feature requests#516
paigerube14 merged 3 commits into
krkn-chaos:mainfrom
Rajeevydvv:feat/github-issue-templates

Conversation

@Rajeevydvv

Copy link
Copy Markdown
Contributor

Documentation Update

Related Feature:
feat/github-issue-templates

Changes:

Added structured GitHub issue templates to the repository.
Previously the repo had zero issue templates — contributors
opening issues had no guidance on what information to provide,
increasing maintainer triage overhead.

Three files added under .github/ISSUE_TEMPLATE/:

  1. bug_report.yml — Structured bug report template with:

    • Page URL field (optional) — helps reproduce doc-specific bugs
    • Bug description (required)
    • Expected behavior field
    • Area dropdown (Documentation, UI, Chatbot, Search, Build, Other)
  2. feature_request.yml — Feature request template with:

    • Feature description (required)
    • Motivation field — why is this useful?
    • Area dropdown (Documentation, UI, Chatbot, Search, DX, CI/CD, Other)
  3. config.yml — Issue template config with contact links:

    • Direct link to #krkn Kubernetes Slack channel for questions
    • Direct link to CONTRIBUTING.md for contributor guidance

Why this matters:

  • Dropdowns ensure issues are consistently categorized
  • Auto-applied labels (bug, enhancement) reduce manual triage
  • Slack + CONTRIBUTING.md links surface the right resources
    before contributors open unnecessary issues
  • Standard practice for CNCF Sandbox projects

This is an additive-only change — zero impact on existing
issues, PRs, code, or site functionality.

…ture requests

Signed-off-by: Rajeev-Cryptographer <Rajeevofficial3@gmail.com>
@netlify

netlify Bot commented May 29, 2026

Copy link
Copy Markdown

Deploy Preview for krkn-chaos ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit c3e401b
🔍 Latest deploy log https://app.netlify.com/projects/krkn-chaos/deploys/6a19ea63958b8800086bb9eb
😎 Deploy Preview https://deploy-preview-516--krkn-chaos.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@qodo-code-review

Copy link
Copy Markdown

Review Summary by Qodo

Add GitHub issue templates for bug reports and features

📝 Documentation

Grey Divider

Walkthroughs

Description
• Add structured GitHub issue templates for bug reports
• Add feature request template with categorization
• Configure issue template settings and contact links
• Auto-apply labels and guide contributors to resources
Diagram
flowchart LR
  A["Issue Templates Setup"] --> B["bug_report.yml"]
  A --> C["feature_request.yml"]
  A --> D["config.yml"]
  B --> E["Auto-label: bug"]
  C --> F["Auto-label: enhancement"]
  D --> G["Contact Links & Settings"]

Loading

Grey Divider

File Changes

1. .github/ISSUE_TEMPLATE/bug_report.yml 📝 Documentation +43/-0

Bug report template with categorization

• Structured bug report template with required description field
• Optional page URL field for reproduction context
• Optional expected behavior field
• Required area dropdown with 6 categorization options
• Auto-applies 'bug' label to new issues

.github/ISSUE_TEMPLATE/bug_report.yml


2. .github/ISSUE_TEMPLATE/feature_request.yml 📝 Documentation +32/-0

Feature request template with area selection

• Structured feature request template with required description
• Optional motivation field explaining usefulness
• Required area dropdown with 7 categorization options
• Auto-applies 'enhancement' label to new issues

.github/ISSUE_TEMPLATE/feature_request.yml


3. .github/ISSUE_TEMPLATE/config.yml 📝 Documentation +8/-0

Issue template configuration and contact links

• Enables blank issues for edge cases
• Adds Kubernetes Slack channel link for questions
• Adds CONTRIBUTING.md guide link for contributors
• Provides quick access to support resources

.github/ISSUE_TEMPLATE/config.yml


Grey Divider

Qodo Logo

@qodo-code-review

qodo-code-review Bot commented May 29, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX issues (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)

Grey Divider


Remediation recommended

1. Brittle CONTRIBUTING link ✓ Resolved 🐞 Bug ⚙ Maintainability
Description
The issue template config hardcodes the contributing guide URL to krkn-chaos/website on the main
branch, which is unnecessarily coupled and can become incorrect (e.g., branch rename) despite
CONTRIBUTING.md existing in-repo. This increases the chance of a broken/misdirected link from the
issue creation UI.
Code

.github/ISSUE_TEMPLATE/config.yml[R6-7]

+  - name: 📖 Contributing Guide
+    url: https://github.com/krkn-chaos/website/blob/main/CONTRIBUTING.md
Evidence
The config hardcodes the contributing URL to .../blob/main/... even though the file exists locally
in this repo, creating unnecessary coupling and a link that can diverge from the in-repo file
location/branch naming.

.github/ISSUE_TEMPLATE/config.yml[6-8]
CONTRIBUTING.md[1-5]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`.github/ISSUE_TEMPLATE/config.yml` links to the contributing guide via a hardcoded GitHub URL that includes a specific org/repo and branch (`main`). This is brittle and can drift from the actual contributing guide in this repository.

### Issue Context
A `CONTRIBUTING.md` file exists at the repository root, so the contact link can be made resilient by referencing the local file (or at least avoiding pinning to a specific branch name).

### Fix Focus Areas
- .github/ISSUE_TEMPLATE/config.yml[1-8]

### Suggested change
Update the contributing guide `url:` to a resilient target, e.g.:
- Prefer a repo-local/relative URL if supported by GitHub issue templates (so forks/renames keep working), or
- Use a branch-agnostic GitHub URL such as `.../blob/HEAD/CONTRIBUTING.md` to avoid coupling to `main`.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Informational

2. Misleading contact link text ✓ Resolved 🐞 Bug ⚙ Maintainability
Description
The contributing-guide contact link description says "before opening a PR" even though this text
appears in the issue creation flow, which is misleading for users opening issues. This can confuse
contributors about what action the link is meant to support.
Code

.github/ISSUE_TEMPLATE/config.yml[8]

+    about: Read the contributing guide before opening a PR
Evidence
The about: string explicitly references PR creation, but it is configured under
ISSUE_TEMPLATE/config.yml contact links shown during issue creation.

.github/ISSUE_TEMPLATE/config.yml[6-8]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The `about:` text for the contributing guide contact link says "before opening a PR", but it is shown on the issue creation page.

### Issue Context
This is a small wording mismatch that can confuse contributors during issue submission.

### Fix Focus Areas
- .github/ISSUE_TEMPLATE/config.yml[6-8]

### Suggested change
Adjust the `about:` text to match the issue context, e.g. "Read the contributing guide before opening an issue or PR."

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

… and PRs

Signed-off-by: Rajeev-Cryptographer <Rajeevofficial3@gmail.com>
…void branch coupling

Signed-off-by: Rajeev-Cryptographer <Rajeevofficial3@gmail.com>
@paigerube14 paigerube14 merged commit d5c9497 into krkn-chaos:main Jul 13, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants