ローファイ日記

出てくるコード片、ぼくが書いたものは断りがない場合 MIT License としています http://udzura.mit-license.org/

個人のリポジトリレベルの開発の話をしよう

最近、個人のリポジトリレベルの開発でも、自分のためのIssueを立て、自分しか見ないPull Requestを作ったりしている。

この際気を付けていることとして:

  • Issue、最初のdescriptionは最初のTODOへのポインタだけ書いておく
  • プルリクエストは 生煮え の状態で出す
  • 思ったこと、詰まったこと、なんじゃこりゃ〜ッてなったことは全部コメントしておく
    • 要するに実況する
  • 考えたことは書いておいて、反論を自分で思いついたら書いて、一人議論する
  • 人様がいきなり見ても分かる程度には体裁を整える

バーダック効果と言うか、 リファクタリング・ウェットウェアに、アヒルの人形に話しかけることで思考を整理するという話がある んだけど、アレをインターネット上の自分に対してやっている感じ。

こうすると、ログとして残す以上に、今自分がやっていることに対して意識的に、客観的になれている感じがする。

新しいことをやる時はコードをコピペして試したりよくわからないけどコマンドを叩きまくったりすると思うけど、こういうことをして少しでも全体像が分かるように、「ああ、こういうことだったのか!」という感じを自分で引き出せるように工夫しているという話でした。落ちも無く。

追記

実は以前までオープンソースでやっていく気持ちがあるプロジェクトのissueとかpull requestは全部英語でやるべきじゃん、派だったんだけれど、このやり方をやるようになると日本語で良いかなという気持ちになった。本当に知りたければ頑張って機械翻訳すると思うし。。

英語問題は、プロジェクトがめっちゃ有名OSSプロダクトになってから考えると良さそう。

そういう意味ではドキュメントやREADME、commit logのほうがパブリックな感じなので、そこは英語にこだわってるかもなーと。