Skip to content

Issue/PRテンプレートとCONTRIBUTING.mdを追加#1467

Merged
TinyKitten merged 2 commits intodevfrom
chore/add-contributor-docs
Mar 26, 2026
Merged

Issue/PRテンプレートとCONTRIBUTING.mdを追加#1467
TinyKitten merged 2 commits intodevfrom
chore/add-contributor-docs

Conversation

@TinyKitten
Copy link
Member

@TinyKitten TinyKitten commented Mar 26, 2026

Summary

  • IssueテンプレートをMarkdownからYAML形式(Issue Forms)に移行し、入力バリデーションを追加
  • データ修正専用のIssueテンプレートを新設
  • PRテンプレートを追加
  • CONTRIBUTING.mdを追加(セットアップ手順、ブランチ命名規則、コントリビューションの流れ)

Closes #7

Test plan

  • GitHub上でIssue作成画面にフォーム形式のテンプレートが表示されること
  • PR作成時にテンプレートが自動で挿入されること
  • 空Issueの作成が無効化されていること

🤖 Generated with Claude Code

Summary by CodeRabbit

リリースノート

  • Documentation
    • Issue テンプレート群を整理:従来の無料記入テンプレートを削除し、より構造化されたフォーム形式のテンプレートを導入
    • プルリクエスト用テンプレートを追加
    • CONTRIBUTING.md を新規作成し開発フローや事前チェック手順を明記
    • README とデータ関連ドキュメント内のコミュニティ(Discord)リンクを更新

- IssueテンプレートをMarkdownからYAML形式(Issue Forms)に移行
- データ修正専用のIssueテンプレートを新設
- PRテンプレートを追加
- CONTRIBUTING.mdを追加

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions bot added the chore ちょっとした変更 label Mar 26, 2026
@TinyKitten TinyKitten self-assigned this Mar 26, 2026
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 26, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fd9269b1-2b73-4343-b140-7836ae1ca281

📥 Commits

Reviewing files that changed from the base of the PR and between 2f13ad5 and 4690fc7.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • README.md
  • data/README.md
✅ Files skipped from review due to trivial changes (3)
  • README.md
  • data/README.md
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

古いMarkdown形式のイシューテンプレート3件を削除し、YAML形式の新テンプレート4件とテンプレート設定を追加。さらにPRテンプレート、CONTRIBUTING.mdを新規追加し、READMEとdata/READMEのDiscordリンクを更新しました。

Changes

Cohort / File(s) Summary
削除されたMarkdownテンプレート
.github/ISSUE_TEMPLATE/Bug.md, .github/ISSUE_TEMPLATE/Epic.md, .github/ISSUE_TEMPLATE/Request.md
既存のMarkdown形式イシューテンプレート3ファイルを完全削除。
新規YAML形式テンプレート
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/epic.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/ISSUE_TEMPLATE/data_correction.yml
構造化されたYAML形式のイシューテンプレート4件を追加(メタデータ、ラベル、アサイン、フィールド定義と検証を含む)。
テンプレート設定
.github/ISSUE_TEMPLATE/config.yml
ブランクイシュー無効化と連絡先(Discord)リンクを定義するテンプレート設定を追加。
プルリクエストテンプレート
.github/pull_request_template.md
PR概要、変更カテゴリチェックリスト、テスト項目、関連イシュー/スクリーンショット欄を含む新規PRテンプレートを追加。
貢献ガイド
CONTRIBUTING.md
ローカルセットアップ、開発ツール、ブランチ命名、データ運用手順、プリコミットチェックやPR要件を記載した新規貢献ガイドを追加。
ドキュメントリンク更新
README.md, data/README.md
Discord招待リンクを新しいURLに更新(両ファイルとも同様のリンク差替え)。

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 新しいテンプレが風に乗り
YAMLの庭に並び立つ
問い合わせはDiscordへ導き
PRと貢献の道しるべになれ
さあ跳ねて、また仕掛けよう 🎋✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PRのタイトルはIssue/PRテンプレートとCONTRIBUTING.mdの追加という変更内容を正確に反映しており、メインの変更を明確に要約しています。
Linked Issues check ✅ Passed Issue #7で要求されたIssue/PRテンプレートとコントリビューション関連ドキュメントの実装が完全に達成されており、すべての目的に対応しています。
Out of Scope Changes check ✅ Passed Discord招待URLの更新はテンプレートとドキュメント整備と関連する適切な変更で、スコープ内の変更です。
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
  • Commit unit tests in branch chore/add-contributor-docs

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

Copy link
Contributor

@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: 1

🧹 Nitpick comments (1)
.github/pull_request_template.md (1)

21-28: テスト手順の記載ルールを統一してください。

Line 26 の cargo clippy コマンドが CONTRIBUTING.md の手順と不一致です(SQLX_OFFLINE=true の有無)。また、チェックボックスだけでなく「実行コマンドと結果」を記入する欄を追加すると、レビュー時の確認が安定します。

Based on learnings: Document the commands executed (e.g., cargo fmt && cargo clippy --all-targets --all-features && make test-unit) and their outcomes in every pull request

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/pull_request_template.md around lines 21 - 28, Update the PR
template test section to standardize test command instructions: adjust the
`cargo clippy` checkbox to match CONTRIBUTING.md (include or omit
`SQLX_OFFLINE=true` as per the canonical doc) and replace/augment the simple
checkboxes with a short "Commands run and results" field (e.g., a code-block
placeholder where authors record the exact commands they executed and their
outcomes such as `cargo fmt --all -- --check`, `cargo clippy --all-targets
--all-features` and `cargo test`), ensuring the template text mentions the
recommended canonical command sequence and asks authors to paste command output
for reviewer verification; update references in .github/pull_request_template.md
accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/ISSUE_TEMPLATE/config.yml:
- Around line 3-5: The Discord invite URL under the "name: \"\U0001F4AC Discord
コミュニティ\"" entry has a different value in its url field
(https://discord.gg/tsemdME9Nz); update that url field to the canonical invite
used in CONTRIBUTING.md so the repository uses a single official Discord link
across files, checking the "name" and "url" keys to locate and replace the
value.

---

Nitpick comments:
In @.github/pull_request_template.md:
- Around line 21-28: Update the PR template test section to standardize test
command instructions: adjust the `cargo clippy` checkbox to match
CONTRIBUTING.md (include or omit `SQLX_OFFLINE=true` as per the canonical doc)
and replace/augment the simple checkboxes with a short "Commands run and
results" field (e.g., a code-block placeholder where authors record the exact
commands they executed and their outcomes such as `cargo fmt --all -- --check`,
`cargo clippy --all-targets --all-features` and `cargo test`), ensuring the
template text mentions the recommended canonical command sequence and asks
authors to paste command output for reviewer verification; update references in
.github/pull_request_template.md accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e89d47d6-8a0f-474f-a81e-4ee17cb338af

📥 Commits

Reviewing files that changed from the base of the PR and between 6e26b6a and 2f13ad5.

📒 Files selected for processing (10)
  • .github/ISSUE_TEMPLATE/Bug.md
  • .github/ISSUE_TEMPLATE/Epic.md
  • .github/ISSUE_TEMPLATE/Request.md
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/data_correction.yml
  • .github/ISSUE_TEMPLATE/epic.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/pull_request_template.md
  • CONTRIBUTING.md
💤 Files with no reviewable changes (3)
  • .github/ISSUE_TEMPLATE/Request.md
  • .github/ISSUE_TEMPLATE/Epic.md
  • .github/ISSUE_TEMPLATE/Bug.md

@TinyKitten TinyKitten merged commit d7c27e0 into dev Mar 26, 2026
3 checks passed
@TinyKitten TinyKitten deleted the chore/add-contributor-docs branch March 26, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore ちょっとした変更 documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Issue/PRテンプレを作る

1 participant