File tree Expand file tree Collapse file tree 1 file changed +40
-0
lines changed
Expand file tree Collapse file tree 1 file changed +40
-0
lines changed Original file line number Diff line number Diff line change 1+ # 🔧 コントリビュートガイド
2+
3+
4+ TinyGo Keeb Workshopでは、作例の追加や資料の改善提案を歓迎しています。
5+ このガイドに従って、ぜひプロジェクトに参加・貢献お願いいたします!
6+
7+ ## 作例の配置
8+
9+ * 作例は ` 数字_作品名/ ` のディレクトリを作成し、その中に配置してください。
10+ * 作品名は英数字とアンダースコア(_ )のみ使用可能です
11+ * 数字は既存作例の最大番号に1を加えた連番を使用してください。重複した場合は、Pull Requestで調整します。
12+ 例)23_akatonbo
13+ * 説明がある場合は、作例ディレクトリ内に ` README.md ` を追加してください。
14+
15+ ## コードの書き方
16+
17+ * ` go fmt ` を使ってコードを整形してください。
18+ * ` go.mod ` はプロジェクトルート(` /go.mod ` )を共通で使用します。個別の作例ディレクトリに ` go.mod ` は作成しないでください。
19+ * 依存の追加が必要な場合は、プロジェクトルートの ` go.mod ` を修正してください。
20+
21+ ## Pull Request の作成方法
22+
23+ * 関連する Issue などがあれば、コミットメッセージや Pull Request の本文にURLを明記してください。
24+ * Pull Request は常に最新の ` main ` から rebase された状態にしてください。
25+ * 作例を新たに追加する場合は、` Makefile ` にスモークテストを追加してください。
26+
27+ ## コードレビュー対応
28+
29+ * コードレビューでは、マージの他にもコメントが Pull Request に追加されることがあります。
30+ * 修正の前に必要に応じてレビュアーと議論してください。
31+ * 修正はフィーチャーブランチに追加のコミットとしてプッシュし、その後、対応済みである旨を Pull Request にコメントしてください。
32+ * 新しいコミットは自動的に Pull Request に反映されますが、レビュアーはコメントされた場合にのみ通知を受け取ります。
33+
34+ ## コントリビュートガイドの議論
35+
36+ * このガイドの議論や改善は、[ issue #24 ] ( https://github.com/tinygo-keeb/workshop/issues/24 ) にて行っています。
37+ また、ご不明な点がありましたら、Discordチャンネル https://discord.com/channels/1267846866444226721/1332545292544901150 まで、お願いいたします。
38+
39+
40+
You can’t perform that action at this time.
0 commit comments