kb84tkhrのブログ

何を書こうか考え中です あ、あと組織とは関係ないってやつです 個人的なやつ

PPP3: Git/GitHub、ドキュメント

しばらく座学的な

Chapter 06 Git/GitHubによるソースコード管理

プル
他の人が編集したファイルをpullする練習、ってときはGitHub上で
ファイルいじればいいのか
わざわざ別ディレクトリにcloneしてたりした

マージ
コンフリクトしたときはstatusってこんなふうになるんだな
見たことなかった
コンフリクトしてマージをなかったことにしたい場合はgit merge --abort

リベース
精通した人がいないならマージを使ったほうが安全
pushする前だけリベースするようにする
リベース運用するならgit config --global pull.rebase trueしておく

GitHub Flow
masterブランチは常にデプロイ可能な状態にする
トピックブランチを切って作業
pushはチャットに通知するとよい
WIPプルリクエストには[WIP]をつける
レビューが終わってステージングで検証したらデプロイ
正常に稼働したらmasterにマージ

GitHubのTips
GFMのタスクはGitHub上で一覧できる
GitHub Issuesを使うとGitHub上で情報を一元管理できる
RedmineにはRedmineのいいところもある)
リポのルートに.github/PULL_REQUEST_TEMPLATE.mdという
ファイルを作っておくとプルリクエストのテンプレートになる

Chapter 07 ドキュメントポートフォリオの作成と利用

SphinxというreStructuredTextベースドキュメント作成システム?の説明
文書作成に関する課題と、それがSphinxによってどう解決させてくれるかが
書いてあってモチベーション上がるんだけれどもここも読むだけにしておく

それだけではなくてどんなドキュメントが必要になるかを考える、
ドキュメントポートフォリオの話にも触れている
こういうの、言われないと考えなきゃいけないってことにも気づいてない
ことがあるので有益