Skip to content

docs: add issue templates and contributing guidelines#307

Open
gene9831 wants to merge 5 commits intoopentiny:developfrom
gene9831:feat/issue-template
Open

docs: add issue templates and contributing guidelines#307
gene9831 wants to merge 5 commits intoopentiny:developfrom
gene9831:feat/issue-template

Conversation

@gene9831
Copy link
Collaborator

@gene9831 gene9831 commented Feb 12, 2026

Summary by CodeRabbit

  • Documentation
    • Added standardized issue templates for bug reports and feature requests with required structured fields and validation to improve reproducibility and triage
    • Enabled blank issue creation and added a contact link directing users to repository discussions
    • Published comprehensive contribution guides (English and Chinese) covering workflow, commit conventions, PR process, and local setup
    • Updated README files to point contributors to the new contribution guides

@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

Walkthrough

Adds GitHub issue templates and config, introduces CONTRIBUTING guides in English and Chinese, and updates README files to reference the new contribution guides.

Changes

Cohort / File(s) Summary
GitHub Issue Templates & Config
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/ISSUE_TEMPLATE/config.yml
Adds a structured bug report form (required fields, placeholders, validation), a structured feature request form (required fields, title/label), enables blank issues and adds a discussions contact link in config.
Contribution Guides
CONTRIBUTING.md, CONTRIBUTING_zh.md
New comprehensive contribution guides (EN & ZH) covering issue reporting, PR workflow, commit message conventions, local dev steps, branch naming, and PR submission process.
README updates
README.md, README_zh.md
Replaces inline contribution instructions with single-line references to the new CONTRIBUTING guides.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through files both near and far,

Forms and guides to steer each PR.
Bugs, requests, and rules in tune—
A tidy warren, ready soon. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes in the PR: adding issue templates (.github/ISSUE_TEMPLATE/) and contributing guidelines (CONTRIBUTING.md, CONTRIBUTING_zh.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In @.github/ISSUE_TEMPLATE/bug_report.yml:
- Line 41: Replace the unclear phrase starting with "After the replay is turned
on" in the reproduction steps paragraph with a clearer, natural-sounding
instruction; specifically update the sentence to something like "What actions
should we perform to reproduce the bug? Clear and concise steps help us locate
the problem more quickly. Issues without clear reproduction steps will not be
addressed. Issues marked with 'need reproduction' that do not provide steps
within 7 days will be closed." so the reproduction guidance reads naturally and
removes the mistranslation; locate the exact string in the template and replace
it accordingly.
- Line 4: Update the label value in the template to match the repository's exact
label name by removing the extra space in the string '🐛  bug' (change to '🐛
bug') or adjust it to whatever exact label text is configured in the repo so
created issues receive the intended label.
- Line 39: Update the label value in the issue template from the singular string
"Step to reproduce" to the plural "Steps to reproduce" so the label reads
correctly; locate the YAML entry with the label key (the line containing label:
Step to reproduce) in .github/ISSUE_TEMPLATE/bug_report.yml and change the
quoted or unquoted label value accordingly.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)

3-3: Nit: hyphenate compound adjective.

"open source project" → "open-source project" when used as a compound adjective before a noun.

Proposed fix
-We are glad that you are willing to contribute to the Tiny Robot open source project.
+We are glad that you are willing to contribute to the Tiny Robot open-source project.

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.

2 participants