docs: add issue-first contribution policy - #14
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation and GitHub issue intake structure to enforce an “issue-first” contribution model for Khone, routing external feedback through evidence-focused issue templates instead of unsolicited PRs.
Changes:
- Added a root
CONTRIBUTING.mdexplaining the issue-first policy and rationale, plus guidance for bug/feature/security reports. - Added GitHub Issue Forms for bug reports, feature requests, and design/use-case feedback, and disabled blank issues.
- Linked the contribution policy from the root README.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Links contributors to the new contribution policy and clarifies PR boundary. |
| CONTRIBUTING.md | Documents the issue-first model, rationale, and reporting expectations (bug/feature/security). |
| .github/ISSUE_TEMPLATE/bug_report.yml | Adds a structured bug report form emphasizing reproducibility and evidence. |
| .github/ISSUE_TEMPLATE/feature_request.yml | Adds a feature request form focused on problem/use-case and constraints. |
| .github/ISSUE_TEMPLATE/design_feedback.yml | Adds a design/use-case feedback form to capture operational and API feedback. |
| .github/ISSUE_TEMPLATE/config.yml | Disables blank issues to route reports through templates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alessandrobologna
marked this pull request as ready for review
May 25, 2026 15:08
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rationale
This documents the project's boundary around unsolicited external pull requests while keeping GitHub issues open for practical feedback, substantiated bugs, feature requests, and real-world use cases. The policy names the maintainer-capacity, project-direction, and CI/CD supply-chain concerns behind that boundary.
Closes #13
Verification
git diff --checkruby -e 'require "yaml"; ARGV.each { |f| YAML.load_file(f); puts "ok #{f}" }' .github/ISSUE_TEMPLATE/*.yml