Hi👋 Diary ~ つながる英語日記 ~

セットアップ方法

Hidiaryディレクトリに移動

xcodegen
open HiDiary.xcworkspace
make setup-mint

バージョン

• Xcode 12.5
• Swift 5.4

環境構築と実行方法

1. git clone https://github.com/techiro/hi-diary.git
2. cd hi-diary
3. open HiDiary.xcodeproj

開発方法

1. develop ブランチから開発用のブランチを切る。（ブランチ名については下のブランチ命名規則を参照）
2. 開発用のブランチで開発を進める。（このブランチからさらにブランチを切ってマージをさせる分には自由にやってもらって大丈夫です。コミットのルールについては下記を参照）
3. develop -> 開発用ブランチにマージをし、コンフリクトが発生していないか確認する。
4. 開発用のブランチ -> develop にプルリクを出す。
5. レビュアーによる承認を得たら、プルリクを出した人がマージさせる。

ブランチ命名規則

• 新規ページ design/[ページ名]
• 新規機能 feat/[機能名]
• 既存機能の修正 fix/[機能名]
• バグ修正 hotfix/[バグ名]
• リリース release/[バージョン]

コミットのルール

• コメントの言語（日・英）に関してはとくに定めていません。
• 頭に、タグ（add:, update:, fix: など）をつけてもらえると非常に見やすいかと思います。
• コミットの粒度については、なるべく細かめにお願いします。（目安としては、1機能1コミット）

コマンド

ターミナルで使えるコマンドです。

make ccache        Delete cache
make sort          Sort file dependencies in Xcode Project

開発するフォルダ構成

UIやDataのフォルダ構成は変更する可能性があるがとりあえずは外部と内部でフォルダを分ける。

• UI 　　　　　 ・・・ 主にローカルでのViewを格納
• Data ・・・ 主に外部でのモデルやサービスを格納
• Configs　　　　　　・・・ 設定ファイルを格納　　　　　　※機密情報が含まれるため触らない
• Sample　　　　　　 ・・・　　　　お試しViewやスニペットなどアプリ開発を構築する上で役に立ちそうなコードを格納.ビルド対象外フォルダ
• Utils　　　　　　　　　　・・・　　　　共通化できるViewやエクステンションを格納