docs: add issue templates and contributing guidelines#307
docs: add issue templates and contributing guidelines#307gene9831 wants to merge 5 commits intoopentiny:developfrom
Conversation
WalkthroughAdds GitHub issue templates and config, introduces CONTRIBUTING guides in English and Chinese, and updates README files to reference the new contribution guides. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.
…inimal reproduction
Summary by CodeRabbit