Skip to content

GitHubの活用

つまみ edited this page Nov 28, 2020 · 3 revisions

次のような方針で開発を進めていきましょう!(いきませんか?)(このページは誰でも書けます)

Flow

流れとして GitHub Flow を採用したいです。強そうなお名前をしてらっしゃいますが、中身は簡単で

  • メインとして main ブランチが存在する
  • mainブランチに触れることは基本的にない
  • 追加したい機能ごとにブランチを切ってブランチ内で作業をする
  • 完成したらmainにmergeする (Pull Request する)

です。簡単!

Project

Projectタブからアイデアペタペタできる付箋のボードを使えます。アイデア決めの時とか便利そう

Wiki

なんかメモしとくのに使う。情報は集約した方が良いので

Issues

バグ修正の依頼投げたり、機能改善の依頼投げたりに使える

Javadoc

mainブランチのコードのJavadocをGitHub Pagesで公開する。公開するとエディタに関数名マウスオーバーした時に関数の使い方とか出て便利

Commit

コミットは日本語だと何してるのかがわかりにくいのでprefixをつけたい

  • 日本語コミットメッセージ
    • 「ハードモードを追加しました」
    • 「キャラクターが動かない問題を修正しました」
    • 動詞が揃わなくて見づらい
  • 英語コミットメッセージ
    • 「Add hard mode」
    • 「Fix the problem that characters doesn't move」
    • 頭に動詞があってわかりやすい

そこで日本語でも先頭に「feat」「fix」「refactor」などの接頭辞(prefix)を付けることで、この問題点を克服できる。

prefixはまだ決めてない、ここを採用したらどうかな?(IDEAにもこれを支援するプラグインがある)