忘れやすいOSSエンジニアに送る、プロダクト名と中身をすぐにわかるようにする方法
完全に名前負け気味ですが、今日はこんなネタです。
僕はOSSプロダクトのソースコードをよくチェックアウトして見る機会が仕事上でもOSS開発でも
結構あります。しょっちゅうチェックアウトしてます。
で、よくあるのが、プロダクト名を見ただけではこいつ何のためにチェックアウトしたんだかがわからなくなったり、
そもそもああこういう状況のために参考にしようと思ってたのにプロダクト名が思い出せない、、、みたいなことが結構あります。
で、今日10分だけ使って、そのことを真剣に鼻血でるくらい考えて見た。
そもそもsvnとかのラベルありますよね。あれでURL見せられても、それだけじゃ全然わからないのが
ダメなんだと。そう思い至りました。完全に責任転嫁どころか逆切れですけどw
というわけで、こうしてみてはどうかというのを一個提案。
まずはperf4jというプロダクトを例にしてみましょう。普通はこう。
まあURLじゃあねえと。で、これを以下のようにしてみてはどうかと。
簡単に言えば各svnのレポジトリごとにラベルをきちんと書くってそれだけなんですけど、僕としては結構しっくりきました。
簡潔にこれが何のためのプロダクトなのかを書いて、その後ろにプロダクト名も書いておきます。
せっかくなので、ライセンスとかも表示させるようにしてみれば、プロダクトの概要がすっきりわかりやすい。
何故いままでデフォルトにしてたのかと小一時間・・・
ちゃんとJavaパースペクティブでも表示されて、気持ちがよくなりました。
あんまり覚えられない僕としては、こういう補助情報は本当に助かります。
ちょっとした発見ですがとても気分がよくなりました。