Skip to content

docs: clarify issue template requirements#7832

Open
sainzs wants to merge 1 commit intoKilo-Org:mainfrom
sainzs:docs/contributing-issue-template-requirements
Open

docs: clarify issue template requirements#7832
sainzs wants to merge 1 commit intoKilo-Org:mainfrom
sainzs:docs/contributing-issue-template-requirements

Conversation

@sainzs
Copy link
Copy Markdown

@sainzs sainzs commented Mar 27, 2026

Context

Fixes #6115.

CONTRIBUTING.md did not explain what issue content is required when contributors open issues through gh, the API, or another path that bypasses the GitHub web UI templates. The repository workflows also link to CONTRIBUTING.md#issue-first-policy and CONTRIBUTING.md#pr-titles, but those headings did not exist.

Implementation

Updated CONTRIBUTING.md to:

  • document the required fields for bug reports, feature requests, and questions
  • list the recommended bug-report fields that help maintainers reproduce issues
  • add explicit Issue First Policy and PR Titles headings so the workflow links resolve correctly

This keeps the fix documentation-only and aligns the guide with the existing issue templates and automation.

Screenshots

before after
CONTRIBUTING.md had no issue-template requirements and no matching anchor headings CONTRIBUTING.md documents the required fields and includes the referenced headings

How to Test

  1. Open CONTRIBUTING.md.
  2. Confirm it now documents the required fields for issue creation outside the GitHub web UI.
  3. Confirm the headings Issue First Policy and PR Titles exist.
  4. Confirm the workflow links in .github/workflows/pr-standards.yml now resolve to matching anchors.

Get in Touch

Discord: add your handle here if you want maintainer follow-up there.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 27, 2026

Someone is attempting to deploy a commit to the Kilo Code Team on Vercel.

A member of the Team first needs to authorize it.

Build and launch the extension in an isolated VS Code instance:

```bash
bun run extension # Build + launch in dev mode
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

WARNING: Documented extension command does not exist

The repo root package.json does not define an extension script, and there is no matching executable in the workspace, so bun run extension will fail immediately for contributors following this guide. This section should point to the existing VS Code launch configurations in .vscode/launch.json or to the real scripts under packages/kilo-vscode/package.json.

@kilo-code-bot
Copy link
Copy Markdown
Contributor

kilo-code-bot bot commented Mar 27, 2026

Code Review Summary

Status: 1 Issue Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 1
SUGGESTION 0
Issue Details (click to expand)

WARNING

File Line Issue
CONTRIBUTING.md 32 bun run extension is documented, but no matching root script or executable exists in the repo.
Other Observations (not in diff)

None.

Fix these issues in Kilo Cloud

Files Reviewed (1 files)
  • CONTRIBUTING.md - 1 issue

Reviewed by gpt-5.4-20260305 · 653,731 tokens

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.

1 participant