Skip to content
Hanasaki edited this page Oct 15, 2021 · 14 revisions

ようこそ

Projectsについて(編集中)

全てのタスク : 来月以降のやるタスク
今月のタスク : 今月やる予定のタスク
Doing : 今やっているタスク
review : 今レビュー待ち(Pull Request)のタスク
Done : 完了したタスク(Issuesをcloseさせる)
Issues追加ごとにProjectにも反映させる
タスクの状態に応じてProjectの状態も変更させること

開発ルール(編集中)

Branch名

feature/#??/hoge : 機能やレイアウトなどを新しく追加した場合
fix/#??/hoge : 機能やレイアウトなど、以前あったものを修正した場合
#??はissueの番号
hoge部分には機能やレイアウト内容を記入(英語のみ)
機能やレイアウト、画面名を入れるとわかりやすい
[例] feature/#??/Map_pin

コミットメッセージ

コミットメッセージの先頭に、以下のプレフィックスのうち当てはまるものをを必ずつけること
feat:hoge : 新しい機能
fix:hoge : バグフィックス
docs:hoge : ドキュメントのみの変更
style:hoge : コードの意味に影響を与えないコーディングスタイルの変更(空白、フォーマットなど)や、xmlデザインの変更
refactor:hoge : 構造の修正
perf:hoge : パフォーマンスを向上させるコード変更
test:hoge : テストコード関係
chore:hoge : ライブラリの追加・変更、リソースの追加、ドキュメントの作成等
hoge部分には機能やレイアウト内容を簡潔に記入(日本語でも良い)
[例] feat:マップ上にピンを表示

Pull Request

テンプレートに沿って入力する
言葉で説明しにくい場合には画像を貼る

Issues

テンプレートに沿って入力する
Labels, Assigneesを追加する
文字の値
strings.xmlに登録して使う
LayoutファイルのID
UIパーツ名(TextViewやImageViewなど)とその役割がわかるようなIDをつける
[例] favorite_Button
↓その他の候補 favoriteButton, Favorite_Button, favorite_Button, favorite_button
作成ファイル名
Fragmentであれば、HogeFragment.kt
Hogeには、そのfragmentの画面等を記入
[例] MapFragment.kt
IssuesとPull Requestのテンプレファイルはあるので適宜変更を行なう。
1人以上のレビューをもらって、Mergeすること(一人以上からレビューをもらわないとMergeできません)

GitHubに適用中の設定

Branch protection rules

設定した項目(対象:main, developブランチ)

  • main, developへの直接push不可
  • メンバー1人以上のレビューでマージ可能
  • マージの際、管理者(メンバー5人)のレビュー必須(メンバー以外の人のレビューでマージはできません)
  • マージ前のrebase必須(要検討)→解除中
  • 管理者にもルールを適用
  • CIの成功必須(CIが設定されていないので無視してOK)