Q&A
Git flow とか GitHub flow とか使えば説明は不要ですが、説明が必要なフローを使うなら説明した方が良いのでは？
Github初学者です。
各branchの役割/説明はREADME.mdなどで一般的に行わないのでしょうか。
（Githubのレポジトリの慣習に関わる部分だと思います。）
色々なリポジトリを眺めていると
ブランチ名からどんなブランチかはっきり分からないものが多々あります。
それらの殆どは改修用ブランチであることは何となくわかるのですが、
それが分からない人もいると思いますし、
cloneしたい際に知らずのうちに作業用ブランチに切り替えてしまって、
cloneしてしまったみたいなケースも想定できます。
そう考えると、ブランチの説明をどこかで行うのが親切なのではと思うのですが、
一般的にはブランチの説明は行わないのでしょうか。
長くなってしまいましたが、よろしくお願いいたします。
前提認識
・branchは作業場所で、バージョン管理はタグで行うのが一般的である。
・リモートbranchには最新版を状態を保ったmainブランチや、作業中のdevelopブランチなどがある。
・各バージョンの更新内容は、"releases"の説明欄やREADME.mdのreleaseトピック、
RELEASE.mdで説明するのが一般的。
・閲覧者がデータをダウンロードしたい場合は、
多くは"releases"や"タグ", mainブランチでのcloneやzipのダウンロードを行う。
コメントありがとうございます。
初心者質問ですみません。
Git flowやGitHub flowを採用しているリポジトリでは、
これらの開発運用方法を知らない人のために
developブランチの説明として「開発用で～を修繕、開発している」などは記載しないのが一般的なのでしょうか。
一般的かどうかは統計をとったわけではないので知りませんが、説明しなくても大丈夫だと思います。
そうなのですね。ありがとうございます。
最後の質問なのですが、
ある程度スター数が多いリポジトリを見ると、 developという名前のブランチは見あたらなかったので、 developブランチやhotfixブランチの役割を持った様々な名前のブランチを作っているのかなと思いましたがこの認識はあっていますでしょうか。
・github.com/vuejs/vue ・github.com/google/googletest ・github.com/git/git/tree/maint/Documentation ・github.com/tensorflow/tensorflow・https://github.com/EbookFoundation/free-programming-books
GitHub flow には develop はありません。
失礼しました。
GitHub flowを採用して説明的なブランチ名をつけているのでやはり説明はいらないということですね。
お答え頂きありがとうございました。
あなたの回答
tips
プレビュー
