From 4ab9d6a3bfa590f5fe58f402c0e841cf1b18a525 Mon Sep 17 00:00:00 2001 From: rdon Date: Mon, 16 Jun 2025 12:18:08 +0900 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b1dc62a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# 🔧 コントリビュートガイド + + +TinyGo Keeb Workshopでは、作例の追加や資料の改善提案を歓迎しています。 +このガイドに従って、ぜひプロジェクトに参加・貢献お願いいたします! + +## 作例の配置 + +* 作例は `数字_作品名/` のディレクトリを作成し、その中に配置してください。 +* 作品名は英数字とアンダースコア(_)のみ使用可能です +* 数字は既存作例の最大番号に1を加えた連番を使用してください。重複した場合は、Pull Requestで調整します。 + 例)23_akatonbo +* 説明がある場合は、作例ディレクトリ内に `README.md` を追加してください。 + +## コードの書き方 + +* `go fmt` を使ってコードを整形してください。 +* `go.mod` はプロジェクトルート(`/go.mod`)を共通で使用します。個別の作例ディレクトリに `go.mod` は作成しないでください。 +* 依存の追加が必要な場合は、プロジェクトルートの `go.mod` を修正してください。 + +## Pull Request の作成方法 + +* 関連する Issue などがあれば、コミットメッセージや Pull Request の本文にURLを明記してください。 +* Pull Request は常に最新の `main` から rebase された状態にしてください。 +* 作例を新たに追加する場合は、`Makefile` にスモークテストを追加してください。 + +## コードレビュー対応 + +* コードレビューでは、マージの他にもコメントが Pull Request に追加されることがあります。 +* 修正の前に必要に応じてレビュアーと議論してください。 +* 修正はフィーチャーブランチに追加のコミットとしてプッシュし、その後、対応済みである旨を Pull Request にコメントしてください。 +* 新しいコミットは自動的に Pull Request に反映されますが、レビュアーはコメントされた場合にのみ通知を受け取ります。 + +## コントリビュートガイドの議論 + +* このガイドの議論や改善は、[issue #24](https://github.com/tinygo-keeb/workshop/issues/24) にて行っています。 +また、ご不明な点がありましたら、Discordチャンネル https://discord.com/channels/1267846866444226721/1332545292544901150 まで、お願いいたします。 + + +