コードで重要でないタイプミス(たとえば、print(error)ステートメントの誤ったアポストロフィ)に遭遇した場合、そのエラーを解決するためにコミットする価値がありますか、それともそのままにしておくべきですか?
具体的には、これらの重要ではないタイプミスを解決する価値に対して、コミットログのガムアップを比較検討することに興味があります。私はそれらを解決することに傾いています。私はつまらないですか?
コードで重要でないタイプミス(たとえば、print(error)ステートメントの誤ったアポストロフィ)に遭遇した場合、そのエラーを解決するためにコミットする価値がありますか、それともそのままにしておくべきですか?
具体的には、これらの重要ではないタイプミスを解決する価値に対して、コミットログのガムアップを比較検討することに興味があります。私はそれらを解決することに傾いています。私はつまらないですか?
回答:
私の個人的な感じは、小さな改善であっても、品質を改善することは、追加のコミットログエントリのマイナーな不便の価値があるということです。結局のところ、壊れたウィンドウ効果を考慮に入れると、小さな改善が非常に重要になります。
TRIVIAL:
タグをプレフィックスとして付けるか、VCSでサポートされている場合は簡単にマークすることをお勧めします。
それはだメンテナンス性高めるために、常にそれだけの価値があなたのソフトウェアのを。
ちょうどそれのために行きます。
...そして、あなたがチームリーダーでない場合は、彼/彼女に確認してください。
孤立したタイプミスを修正するだけの場合は、少なくとも「機能」関連のコミットとは区別できるような何かを書くべきだということには、他の人たちも同意します。
一般的な方法は、タイムトラッカーと無限の変更を追跡するために、課題トラッカーに死ぬことのないタスクを含めることです。たとえば、次のタスクを実行することは珍しくありません。
正しく文書化されたチケットを作成するのが面倒になったときに、これらはほとんど何でも捨て可能なタスクIDとして使用されないことに注意してください。特に、IDにリンクされていないコミットを拒否する場合(これは良いことですが、このような大きなタスクは怠beな開発者にとってさらに魅力的です)。
はい、特にプロジェクトの早い段階でこれを絶対に行う必要があります。
どうして?2つのポイント:
タイプミスが「クリティカル」であるかどうかは、手遅れになるまでわかりません。誰もが大した問題ではないと考えているため、いくつかの修正はおそらく修正されません。それまでです。
数百行のコード/関数呼び出しが行われた後で修正するよりも、タイプミスを早期に意図的に修正する方がはるかに簡単です。繰り返しますが、一時的なハッキングは驚くほど急速に半永久的になります。これが、「CollapseAll」メソッドと「ColapseAll」メソッドの両方を持つオブジェクトを処理する必要がある理由です。
コミットログをいっぱいにすることを心配しているなら、あなたは何か間違ったことをしている。:-)頻繁なコミットは良いことです!私は常にタイプミスを修正します。コードベースをできるだけ早く入手して、開発サイクルをスピードアップしてください!
I commit typo fixes all the time
気になるIMO、英語が上手なプログラマーを探してみませんか?
変更管理プロセスで許可されていますか?
私の環境では、コミットするたびに、ビジネスユーザーまたは必須のシステムレベルの変更のいずれかによって要求された変更要求に結び付け、対応するエンドユーザーテストプロセスを完了する必要があります。あなたが説明しているような単純なタイプミスはおそらくそれらのいずれとしても記録されないでしょう(誰も気付かずに4年以上存在していた私のアプリの1つでタイプミスと文法エラーを見つけました)私は自分自身を説明するのは非常に困難な時間を持っていると呼んでいます。
あなたが説明しているような変更を保存します(実際には、実際には変更があります-メソッド名のつづりが間違っているため、それを発見しました)。同様に作成し、ログに「修正されたさまざまなタイプミス」を入れます。
クリーンなコミット履歴が心配な場合は、機能ブランチで主な作業を行うことを検討してください。たまたま分散VCSで作業している場合は、コミット履歴を簡単に編集してからメインブランチにプッシュできます。SVNを使用している場合は、Gitを試してください-Subversion と双方向でやり取りできます。また、実際にSubversionにコミットする前に履歴を編集することもできます。
コミット履歴を編集したくない、または編集できない場合、自動テストまたはコンパイルに影響しないマイナーなタイプミスに対して早期コミットまたはアトミックコミットを実行する機能的な理由はありません。この場合、私の意見では、コミット履歴をクリーンに保つことは、本当にアトミックなコミットを行うよりも重要であるはずです。ミキシング1または2「通常」の変更でタイプミスを修正しても、潜在的なレビュープロセスに害を与えないだろう。ただし、大きなコーディングセッションの後に「クリーンアップ」する場合など、いくつかの些細な修正を1つのコミットにグループ化することもできます。
機能的なバグは、アトミックコミットでできるだけ早くコミットする必要があることに注意してください。
ここでの回答の一般的なトーンは、小さなタイプミスでも「すべてを高速にコミットする」戦略を示唆しているようです。私は意見が合わず、議論を歓迎する傾向があります。