Feature/unkoo

docs/README.md

@@ -10,3 +10,4 @@
 ## ページマップ
 
 - [ブランチルール](branch.md)
+- [コミットルール](commit.md)

docs/branch.md

@@ -89,3 +89,143 @@ gitGraph
   checkout master
   merge develop tag: "v0.0.2"
 ```
+
+## 原則
+
+マージするときは例外以外はローカルでマージするのではなくリモートでPull Requetsを通してマージしてください。
+
+例外については`hotfix`ブランチから`develop`ブランチにマージする場合です。  
+これが可能になる場面は、`hotfix`ブランチから`master`にPull Requestsを通して、マージされた場合Pull Requetsをマージした担当者が`hotfix`ブランチを`develop`ブランチにマージしてください。  
+コンフリクトが発生した場合はそれまでの`develop`ブランチの貢献者と`Pull Requests`作成者と協力してコンフリクトを解消してください。
+
+`git merge`コマンドを使ってマージしてはいけません。  
+また`develop`ブランチにPull Requestsを通して、作成したブランチをマージした場合、GitHub Actionsが自動でリモートのブランチを削除します。  
+リモートでマージ済みのブランチをローカルで削除するかは委任します。
+
+## ブランチ一覧
+
+### master
+
+原則として`master`ブランチに直接コミットしないでください。
+
+このブランチは`develop`及び`hotfix`ブランチからPull Requestsを通してマージされます。  
+なお、このブランチは必ず動作するコードがコミットされます。  
+デバッグ中のコード及び動かないコード等を含むブランチをマージしないでください。
+また、`master`ブランチにマージする権限を持つものはリポジトリオーナーのみ可能です。
+
+### develop
+
+原則として`develop`ブランチに直接コミットしないでください。
+
+このブランチは`feature`及び`fix`及び`test`及び`docs`及び`refactor`ブランチからPull Requestsを通してマージされます。  
+このブランチには追加及び変更した機能が動作する状態でマージしてください。
+
+### hotfix
+
+原則として`hotfix`ブランチの命名規則は`hotfix/機能名`です。機能名は英語で記載してください。
+
+`hotfix`ブランチは`master`ブランチにてすでに提供されているコードに早急に直すべきバグ及び脆弱性等が見つかった場合に作成及び使用するブランチです。
+
+このブランチを作るときは以下のコマンドを実行してください。
+
+```bash
+git checkout -b hotfix/feat-name master
+```
+
+作成したらリモートにプッシュしてください。
+
+```bash
+git push --set-upstream origin hotfix/feat-name
+```
+
+このブランチでは自由に作業してもらって構いません。  
+未完成のコードをコミットしても問題ないです。  
+ただ、`master`にマージする場合は完成させてからPull Requestsを通してマージしてください。
+
+### feature
+
+原則として`feature`ブランチの命名規則は`feature/機能名`です。機能名は英語で記載してください。
+
+`feature`ブランチは新機能を作成する場合に作成及び使用するブランチです。
+
+このブランチを作るときは以下のコマンドを実行してください。
+
+```bash
+git checkout -b feature/feat-name develop
+```
+
+作成したらリモートにプッシュしてください。
+
+```bash
+git push --set-upstream origin feature/feat-name
+```
+
+このブランチでは自由に作業してもらって構いません。  
+未完成のコードをコミットしても問題ないです。  
+ただ、`develop`にマージする場合は完成させてからPull Requestsを通してマージしてください。
+
+### fix
+
+原則として`fix`ブランチの命名規則は`fix/機能名`です。機能名は英語で記載してください。
+
+`fix`ブランチはバグや脆弱性等を修正する場合に作成及び使用するブランチです。
+
+このブランチを作るときは以下のコマンドを実行してください。
+
+```bash
+git checkout -b fix/feat-name develop
+```
+
+作成したらリモートにプッシュしてください。
+
+```bash
+git push --set-upstream origin fix/feat-name
+```
+
+このブランチでは自由に作業してもらって構いません。  
+未完成のコードをコミットしても問題ないです。  
+た
+
+### test
+
+原則として`test`ブランチの命名規則は`test/機能名`です。機能名は英語で記載してください。
+
+`test`ブランチは機能をテストする場合に作成及び使用するブランチです。
+
+このブランチを作るときは以下のコマンドを実行してください。
+
+```bash
+git checkout -b test/feat-name develop
+```
+
+作成したらリモートにプッシュしてください。
+
+```bash
+git push --set-upstream origin test/feat-name
+```
+
+このブランチでは自由に作業してもらって構いません。  
+未完成のコードをコミットしても問題ないです。  
+ただ、`develop`にマージする場合は完成させてからPull Requestsを通してマージしてください。
+
+### docs
+
+原則として`docs`ブランチの命名規則は`docs/内容`です。内容名は内容を一言に要約したものを英語で記載してください。
+
+`docs`ブランチはドキュメントを編集及び追加する場合に作成及び使用するブランチです。
+
+このブランチを作るときは以下のコマンドを実行してください。
+
+```bash
+git checkout -b docs/feat-name develop
+```
+
+作成したらリモートにプッシュしてください。
+
+```bash
+git push --set-upstream origin docs/feat-name
+```
+
+このブランチでは自由に作業してもらって構いません。  
+未完成のコードをコミットしても問題ないです。  
+ただ、`develop`にマージする場合は完成させてからPull Requestsを通してマージしてください。

docs/commit.md

@@ -0,0 +1,70 @@
+##### Contributor向けドキュメント
+
+# コミットメッセージのルールについて
+
+## 前提
+
+本プロジェクトでは管理の効率化のためコミットメッセージにフォーマットをを定めております。
+
+- [参考](https://qiita.com/Jung0/items/0a9a7a97a2c17f92d3c5)
+
+## フォーマット
+
+フォーマットについては以下のとおりです。
+
+```
+# ==================== Format ====================
+# :emoji: Subject (Dir/AddedFile Dir/AddedFile)
+#
+# Commit body...
+```
+
+### 絵文字
+
+フォーマットには`:emoji:`という項目があります。
+この絵文字はただの絵文字でもいいですが、絵文字プレフィックスを使うと楽でしょう。
+[絵文字プレフィックス一覧](https://gist.github.com/rxaviers/7360908)をご覧してください。
+
+このプロジェクトでは使う絵文字は以下のとおりです。
+
+```
+# ==================== Emojis ====================
+# 🎉  :tada: 初めてのコミット（Initial Commit）
+# ♻️   :recycle: マージ(Merge)
+# 🔖  :bookmark: バージョンタグ（Version Tag）
+# ✨  :sparkles: 新機能（New Feature）
+# 🐛  :bug: バグ修正（Bagfix）
+# 👀  :eyes: リファクタリング(Refactoring)
+# 📚  :books: ドキュメント（Documentation）
+# 🎨  :art: デザインUI/UX(Accessibility)
+# 🐎  :horse: パフォーマンス（Performance）
+# 🔧  :wrench: ツール（Tooling）
+# 🚨  :rotating_light: テスト（Tests）
+# 💩  :hankey: 非推奨追加（Deprecation）
+# 🗑️  :wastebasket: 削除（Removal）
+# 🚧  :construction: WIP(Work In Progress)
+# ☃️  :snowman: 仕様変更
+
+# ==================== Format ====================
+# :emoji: Subject (Dir/AddedFile Dir/AddedFile)
+#
+# Commit body...
+```
+
+## コミットの効率化
+
+このフォーマットでコミットするのに最適な[pummit](https://github.com/HidemaruOwO/pummit)というツールを作成しました。
+
+<div align="center">
+
+[![Pummit Stats](https://socialify.git.ci/HidemaruOwO/pummit/image?description=1&font=Raleway&forks=1&issues=1&language=1&name=1&owner=1&pattern=Brick%20Wall&pulls=1&stargazers=1&theme=Light)](https://github.com/HidemaruOwO/pummit)
+
+</div>
+
+このツールでは以下のようなコミットを作成することができます。
+
+![Pummit Log](assets/pummit.png)
+
+使用方法についてはpummitのREADMEをご覧ください。
+
+https://github.com/HidemaruOwO/pummit