docs: add issue template compliance guidance to CONTRIBUTING.md#596
docs: add issue template compliance guidance to CONTRIBUTING.md#596Olusammytee wants to merge 2 commits intoKilo-Org:devfrom
Conversation
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Other Observations (not in diff)Issues found in unchanged code that cannot receive inline comments:
Files Reviewed (1 file)
|
There was a problem hiding this comment.
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
ghCLI 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. |
There was a problem hiding this comment.
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.
| 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. |
|
Pushed a small wording clarification in the API/CLI compliance section to improve readability and trigger a fresh CI run. |
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