コントリビュートガイド¶
コントリビュートにご関心をお寄せいただきありがとうございます!
はじめに¶
GitHub でリポジトリをフォークします
フォークをクローンします:
git clone https://github.com/<your-username>/jpyc-tipjar-widget.git
開発環境をセットアップします
フィーチャーブランチを作成します:
git checkout -b feature/my-feature
開発ワークフロー¶
ブランチ命名¶
プレフィックス |
用途 |
|---|---|
|
新機能 |
|
バグ修正 |
|
コードのリファクタリング |
|
ドキュメント |
|
テストの追加 |
|
設定、依存関係 |
コミットメッセージ¶
コミットメッセージには絵文字プレフィックスを使用します:
絵文字 |
用途 |
|---|---|
✨ |
新機能 |
🐛 |
バグ修正 |
♻️ |
リファクタリング |
📝 |
ドキュメント |
🔧 |
設定変更 |
✅ |
テストの追加 / 修正 |
フォーマット: <emoji> <verb> <concise description>
変更の提出¶
すべてのテストが通ることを確認します
コードスタイルチェックが通ることを確認します
プロジェクトをビルドします
ブランチをプッシュしてプルリクエストを作成します
PR ガイドライン¶
PR は単一の機能または修正に絞ります
何を、なぜ変更したのかを明確に記述します
該当する場合は関連 Issue を参照します