PR/Issue テンプレートを追加しました #1305
PR/Issue テンプレートを追加しました #1305
Conversation
WalkthroughThe repository has been updated with new templates to streamline the process of reporting bugs, requesting features, and submitting pull requests. These templates are designed to ensure that contributors provide all the necessary information, which should help maintainers understand and address issues and suggestions more efficiently. Changes
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (3)
- .github/ISSUE_TEMPLATE/bug_report.md (1 hunks)
- .github/ISSUE_TEMPLATE/feature_request.md (1 hunks)
- .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
Files skipped from review due to trivial changes (1)
- .github/ISSUE_TEMPLATE/feature_request.md
Additional comments: 1
.github/ISSUE_TEMPLATE/bug_report.md (1)
- 2-7: The metadata fields are in Japanese. Verify that this is intentional and that the target audience for this repository includes Japanese speakers. If not, these fields should be translated into English to maintain consistency with the rest of the template.
| ## What's PR | ||
|
|
||
|
|
||
| ## Review checklist | ||
| - [ ] xx | ||
| - [ ] oo |
There was a problem hiding this comment.
The new section "What's PR" should have a brief explanation or instruction on what should be included in this section. The review checklist items 'xx' and 'oo' are placeholders and should be replaced with actual criteria that need to be checked before a pull request is considered ready for review or merging.
## What's PR
+ Please provide a summary of the pull request's purpose and any key changes made.
## Review checklist
- [ ] xx
+ [ ] Code complies with the project's coding standards
- [ ] oo
+ [ ] All tests passCommitable suggestion
[!IMPORTANT]
Carefully review the code before committing. Make sure it correctly replaces the highlighted code, has no missing lines and indentaion issues.
| ## What's PR | |
| ## Review checklist | |
| - [ ] xx | |
| - [ ] oo | |
| ## What's PR | |
| Please provide a summary of the pull request's purpose and any key changes made. | |
| ## Review checklist | |
| - [ ] Code complies with the project's coding standards | |
| - [ ] All tests pass |
| **バグの説明** | ||
| そのバグが何であるかを明確かつ簡潔に記述してください。 | ||
|
|
||
| \*\*再現方法 | ||
| その動作を再現するための手順。 | ||
|
|
||
| 1. '...' に移動します。 | ||
| 2. '...' をクリックします。 | ||
| 3. スクロールダウンして '......' をクリックします。 | ||
| 4. エラーを見る | ||
|
|
||
| \*\*期待される動作 | ||
| 期待した動作の明確で簡潔な説明。 | ||
|
|
||
| **スクリーンショット** | ||
| 該当する場合、問題を説明するためにスクリーンショットを追加してください。 | ||
|
|
||
| **デスクトップ（以下の情報を記入してください）:**。 | ||
|
|
||
| - OS。[例：iOS]（アイオーエス | ||
| - ブラウザ [例：クローム、サファリ]。 | ||
| - バージョン [例: 22］ | ||
|
|
||
| \*\*スマートフォン（以下の項目を入力してください） | ||
|
|
||
| - デバイス [例：iPhone6］ | ||
| - OS: [例：iOS8.1］ | ||
| - ブラウザ[例：純正ブラウザ、safari]。 | ||
| - バージョン [例：22]。 | ||
|
|
||
| **その他の状況**について | ||
| 問題についてのその他の状況をここに追加してください。 |
There was a problem hiding this comment.
The bug report template is well-structured and covers all the necessary sections to gather detailed information about a bug. However, the language used in the template is mixed, with some parts in Japanese and others in English. Ensure that the language is consistent throughout the document to avoid confusion. If the repository is intended for a multilingual audience, consider providing separate templates for each language or including language-specific sections within the same template.
Summary by CodeRabbit