Skip to content

docs: add issue templates for bug reports and feature requests - #1045

Merged
mbevc1 merged 3 commits into
mainfrom
20260728_issue-templates
Jul 28, 2026
Merged

docs: add issue templates for bug reports and feature requests#1045
mbevc1 merged 3 commits into
mainfrom
20260728_issue-templates

Conversation

@mbevc1

@mbevc1 mbevc1 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Adds GitHub Issue Forms under .github/ISSUE_TEMPLATE/:

  • bug_report.yml
  • feature_request.yml
  • config.yml linking to docs.kosli.com

Amend existing PR template.

Checklist

@mbevc1 mbevc1 added the documentation Improvements or additions to documentation label Jul 28, 2026
@claude

claude Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 52s —— View job


Re-review after latest push ✅

  • Read all changed files
  • Re-check the previously-flagged blocking issue
  • Validate the issue forms

The blocking issue is resolved. The duplicate - type: checkboxes in feature_request.yml is gone. The form now parses cleanly:

body:
  - type: markdown
    attributes:
      value: Thanks for taking the time to suggest an improvement!
  - type: checkboxes
    id: preflight
    ...

Both forms now open with a consistent friendly markdown intro, and the structure is valid GitHub issue-form YAML. This will render correctly on the New issue page. 👍

Review summary

This is a clean, well-structured docs-only change (issue forms + a PR-template trim). No Go code touched, so the compile/vet/go mod tidy checks don't apply here.

Nicely done:

  • Thoughtful form fields — bug_report.yml requiring version and using render: shell for logs, plus the redaction reminders for tokens/secrets, are good touches.
  • Preflight "searched existing issues" checkbox on both forms.
  • config.yml keeps a docs escape-hatch link and an intentional blank_issues_enabled: true.

Optional, non-blocking (carried over from earlier):

  • Verify labels exist: labels: ["bug"] and labels: ["enhancement"] are only auto-applied if those labels already exist in the repo — GitHub silently drops unknown ones. Worth a quick confirm under repo Labels.
  • blank_issues_enabled: leaving it true is a valid, deliberate choice (escape hatch); just flagging it's a decision, not a default.

No changes required from me — this looks ready. 🚀

Comment thread .github/ISSUE_TEMPLATE/config.yml
Comment thread .github/ISSUE_TEMPLATE/bug_report.yml
@mbevc1
mbevc1 enabled auto-merge (squash) July 28, 2026 12:16
@mbevc1
mbevc1 disabled auto-merge July 28, 2026 12:17
@mbevc1
mbevc1 force-pushed the 20260728_issue-templates branch from e6814d0 to 2b277a4 Compare July 28, 2026 12:22
Adds GitHub Issue Forms under .github/ISSUE_TEMPLATE/:
- bug_report.yml
- feature_request.yml
- config.yml linking to docs.kosli.com
@mbevc1
mbevc1 force-pushed the 20260728_issue-templates branch from 2b277a4 to f367aef Compare July 28, 2026 12:22
@mbevc1
mbevc1 enabled auto-merge (squash) July 28, 2026 12:23
Comment thread .github/ISSUE_TEMPLATE/feature_request.yml
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Comment thread .github/ISSUE_TEMPLATE/feature_request.yml Outdated
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@mbevc1
mbevc1 merged commit 55fc62a into main Jul 28, 2026
16 checks passed
@mbevc1
mbevc1 deleted the 20260728_issue-templates branch July 28, 2026 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants