Skip to content

Comments

docs: add issue template compliance guidance to CONTRIBUTING.md#596

Open
Olusammytee wants to merge 2 commits intoKilo-Org:devfrom
Olusammytee:docs/574-contributing-issue-template-compliance
Open

docs: add issue template compliance guidance to CONTRIBUTING.md#596
Olusammytee wants to merge 2 commits intoKilo-Org:devfrom
Olusammytee:docs/574-contributing-issue-template-compliance

Conversation

@Olusammytee
Copy link
Contributor

Summary\n- document required fields for issue templates when using CLI/API\n- add missing CONTRIBUTING anchors for Issue First Policy and PR Titles\n- include compliant gh CLI issue creation examples for bug reports, feature requests, and questions\n\n## Testing\n- docs-only change\n\nFixes #574

Copilot AI review requested due to automatic review settings February 22, 2026 16:25
@kiloconnect
Copy link
Contributor

kiloconnect bot commented Feb 22, 2026

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Other Observations (not in diff)

Issues found in unchanged code that cannot receive inline comments:

File Line Issue
CONTRIBUTING.md 196 SUGGESTION: ### Style Preferences is now structurally nested under ## Issue Template Compliance (CLI and API) due to the new ##-level sections added above it. It likely belongs as its own ## section or back under ## Developing Kilo CLI. Consider promoting it to ## Style Preferences.
Files Reviewed (1 file)
  • CONTRIBUTING.md - 0 inline issues

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive issue template compliance guidance to CONTRIBUTING.md to prevent issues created via CLI/API from being auto-closed by the compliance bot. The changes directly address issue #574 by documenting required fields for issue templates and providing working examples of compliant gh CLI commands.

Changes:

  • Added "Issue First Policy" and "PR Titles" sections with proper anchors that the compliance bot links to
  • Documented required fields for bug reports, feature requests, and questions when using CLI/API
  • Included complete gh CLI examples with heredoc syntax showing how to create compliant issues

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

CONTRIBUTING.md Outdated

## Issue Template Compliance (CLI and API)

GitHub Issue Forms enforce required fields in the web UI, but `gh issue create` and API-created issues can bypass that form validation. The compliance bot checks for required structure and may auto-close non-compliant issues after about 2 hours.
Copy link

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section describes a "2 hours" timeframe for auto-closing non-compliant issues, but uses the phrase "about 2 hours" which is vague. Consider being more specific if the exact timeframe is known, or clarify whether this is an approximate or exact duration. This helps users understand the urgency of creating compliant issues.

Suggested change
GitHub Issue Forms enforce required fields in the web UI, but `gh issue create` and API-created issues can bypass that form validation. The compliance bot checks for required structure and may auto-close non-compliant issues after about 2 hours.
GitHub Issue Forms enforce required fields in the web UI, but `gh issue create` and API-created issues can bypass that form validation. The compliance bot checks for required structure and may auto-close non-compliant issues approximately 2 hours after creation; this timeframe is approximate and not guaranteed.

Copilot uses AI. Check for mistakes.
@Olusammytee
Copy link
Contributor Author

Pushed a small wording clarification in the API/CLI compliance section to improve readability and trigger a fresh CI run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant