おこじょめもらんど
803 文字
4 分
ゴミrepositoryを一つのrepositoryにまとめて整理する
2024-06-04

ゴミrepositoryを一つのrepositoryにまとめて整理する#

自分はよくテストや試作品用のrepositoryを大量に量産します。

例えば「test」とか「sample」とか適当な名前でrepositoryを作ってしまいがちでした。

結果、ダラダラとrepositoryが増え、どれが何なのか分からなくなってしまうことが増えてきました。

そういったゴミrepositoryを1つのrepositoryにまとめて、うまく整理できないかなと試行錯誤した過程をメモします。


目次#

ゴミrepositoryはなぜ生まれるのか#

  1. 名前付けを適当に決めてしまう
    1. repositoryを作成する際、とりあえず作ってしまおうという精神から「test」や「sample」などの名前で作ってしまうことがある
    2. 内容が分かりにくく、後から探すのが大変
  2. 古いrepositoryを放置してしまう
    1. 動作確認とかお遊びが完了した後、repositoryを放置してしまうことがある
    2. 後から参考にしたいと思って必要ないのに残しておいてしまったりしてしまうパターン

お試しの解決策:ゴミrepositoryを一つのrepositoryにまとめる#

test、sampleなどのrepositoryをすべて1つの巨大なrepositoryにまとめてみます。

適当に作ったrepositoryたちをフォルダ分けして、もともとの.gitとかを削除して運用して、少なくともGitHub上ではゴミrepositoryをなくして他の参照したいrepositoryがでるようにしました。

運用ルール#

  1. フォルダ分けは適当でも良いが、READMEとかコミットメッセージを丁寧に書く
    1. コミットメッセージにどんな思いで作ったのかとか進捗とかやりたいこととか書く
    2. READMEとかにも残しておくべき理由とか巨大repositoryでゴミrepositoryを管理する目的を書く
  2. Git Flowなどのワークフローは採用しない
    1. 基本的にはmain branchのみの運用を想定
    2. ゴミrepositoryをぶち込むためにいちいちPRとか出してマージするの面倒

実践してみての今のところの結論#

  • 良いところ
    • ゴミみたいなrepositoryがまとめられてすっきり
    • 適当に名前つけてわかんなくなったらこのrepository見れば良くなった
  • 悪いところ
    • ゴミみたいなrepository毎にちゃんと.gitignore書かないと面倒なことになる
      • ただ、今後ゴミから昇格させたいとか出てきたらちゃんとしなきゃいけないからちゃんと書くくせはつけたい
    • GitHubの検索性とか見栄えは良くなったけどローカルだと微妙に探しにくい気がする
      • 結局サブのrepositoryを検索しないとって感じだし
      • アーカイブとまではいかないけど重要視しなければいいかなというところ

まだまだ運用はじめなのでなんか微妙になってきたらまた考えよう

ゴミrepositoryを一つのrepositoryにまとめて整理する
https://okojomemorandum.com/blog/organize-unnecessary-repo/
作者
Okojomoeko
公開日
2024-06-04
ライセンス
CC BY-NC-SA 4.0