エンジニアなら個人開発をすることもあるでしょう。僕もプライベートで個人開発を続けています。せっかくなら、外部からも見えるような形で開発をしたほうが自分の実績をアピールすることにも繋がります。
なので、個人開発だとしてもIssueとプルリクをちゃんと使うのが良いと考えています。
目次
Issueを起票する
メリット
- ブランチ名がissueに紐づくため現在の作業が明確になる
- issueに対してブランチを紐付けられる
なので、今の開発が何のIssueに対して行われているのか明確になる
ブランチ名の付け方
私が敬愛するLogseqのブランチ名を参考にする。
GitHub
GitHub - logseq/logseq: A privacy-first, open-source platform for knowledge management and collabora...
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trell...
ブランチルール
- メインブランチ：main
- 機能開発ブランチ：feat/〇〇-〇〇_(#issue番号)←英語で記入すること
- 不具合修正ブランチ：fix/〇〇-〇〇_(#issue番号)←英語で記入すること
- ブランチ名に空白を使うことはできないので、「-」を使用すること。
- issue番号の前には「アンダースコア」を入れること。
Logseqのブランチ名
- main →Logseqはmasterだがmainを使用する
- issue番号とブランチ名での紐づけは行っておらず、コミットメッセージにissue番号を書いている。（issueは起票者にチェックしてもらってからcloseするため。）
- 「fix/no-indent-block-src」「feat/」などのブランチ名を採用している
コミットメッセージ
issueを閉じるためには``close #12``のようなコミットメッセージをつけると自動的にissueが閉じられます。
ラベルの付け方
| ラベル名 | 使い方 |
|---|---|
| hotfix | バグを修正するとき |
| enhancement | 機能の追加や改善をするとき |
| duplicate | 同じ内容のissueがあるとき |
| documentation | ドキュメント修正するとき |
| good first issue | OSSなどで最初に取り組むと良いもの |
| wontfix | 意図的に改善しないとき |
| help wanted | ヘルプを求めたいとき |
| question | 質問するとき |
参考文献
Qiita
［GitHub］一人開発でもissueベース/セルフプルリクエストを使って開発する - Qiita
issueベース開発 サンデープログラマーにとってGitHubはmasterブランチで実装したものをpushしておくだけ。 いわばただのバックアップ置き場になっている事も多いでしょう...
Qiita
【メモ】Issueドリブン開発とブランチ命名規則ついて【Git】 - Qiita
こんにちわ=) 初学者の皆さんは「Issueドリブン開発」や、Gitのブランチ名にも命名規則があるのを知ってますでしょうか？ 自分は「聞いたことあるな」くらいにしか考えてい...
コメント