Project

General

Profile

機能 #1473

.rubocop.yml を用意する

Added by toshi_a 初音 2 months ago. Updated about 1 month ago.

Status:
終了
Priority:
通常
Target version:
Start date:
2020-09-15
Due date:
% Done:

0%

プラグイン名:

Description

現在もmikutterのコーディングの指針は存在するが、現在のコーディング規約を知るためには直近のコミットを参照して察するしか無い。

  • サードパーティプラグインを取り込むときに、そのプラグインとmikutterの現在のコーディング規約と一致しない
  • パッチを貰ったときに、コーディング規約に合うようにコミッタが書き換えることがある
    • が、明確な指針がないため、コミッタの判断だとブレることがある

そこで、コードを取り込むときにコードを修正する明確な指標として.rubocop.ymlを設置し、コーディング規約としてこのファイルをメンテナンスする。

close後の運用

以前のコードについて

以前のコードの中には多くのコーディング規約違反が発生するはずだが、修正しない。blameの結果が見辛くなってバグの原因を追跡する時のコストが上がるからだ。

ただし、不具合修正やリファクタリングなどで編集した位置が規約に違反している場合、規約に沿うように書き換える(現在と同じ運用)。

「編集した位置」の定義は、行単位にするか、あるいはreviewdogなどのツールを使うか……(ゆくゆくCIなどで評価することになることを考えたら、ツールに頼ったほうが良さそう?)。

#1

Updated by toshi_a 初音 about 1 month ago

  • Status changed from 実装待ち to 終了

merged.

Also available in: Atom PDF