.editorconfigにMarkDownを追加して体裁を揃えたい

[sanomari]

PR の目的

タイトル通りです。

カテゴリ

• リファクタリング
• ドキュメント修正

PR の背景

ここのプロジェクトのドキュメントってMarkDownで書かれています。
MarkDownって誰でも簡単に編集できる便利な形式ですが、あまり更新されていません。

なんで誰も更新しないのかずっと疑問に思っていましたが、先ほど理由が分かりました。

MarkDownを編集して保存すると、インデントが崩れるようになってるんですよ。

自分が編集したところ以外に差分が出るファイルを触るのは嫌なものです。
壊してしまったんじゃないかって不安になります。

軽くコミットログを漁ってみた感じ、.editorconfig導入以前に作成されたmdファイルのインデント設定が+4で、標準の+2と違うから差分が出てしまうようです。対策として、.editorconfigでインデントを標準の+2が使われるようにし、保存するとエディタ設定によって差分が出ることになるファイルを更新した状態のコミットを反映するリクエストを送ることにしました。

PR のメリット

背景に記載した通りです。

PR のデメリット (トレードオフとかあれば)

とくに思い当たりません。

仕様・動作説明

.editorconfigの仕様についてはみなさんご存じだと思います。

スタイルでスペースかタブを選び、
サイズでスペース何個分をインデント単位とするかを指定します。
通常のテキストファイルでは、行末空白を削らせる設定にしますが、
MarkDownの行末空白には意味があるのでキープする設定にします。

PR の影響範囲

MarkDownドキュメントの編集に影響する変更です。

テスト内容

このPRを適用した状態でREADME.mdを編集(保存)し、編集部分以外に差分が出ないことを確認しました。

関連 issue, PR

#1502

参考資料

[berryzplus]

パターン指定が効かないから個別指定に変えます、というのは了解です。
標準のインデント幅がスペース2個分、というのもそうなんだと思います。

既存ドキュメントのインデント幅4を修正してよいかについてちょっと悩んでいます。
ここまでのやり取りで、こういう修正は嫌がられてきたと思っているからです。

加えて、修正根拠の「意図しない変更の要因になる」と「意図しない変更が発生することが修正を妨げている」も疑問です。

どうしていきたいか、だけを考えたらGOで良いと思うんですが。

[sanomari]

ここまでのやり取りで、こういう修正は嫌がられてきたと思っているか

具体的な反対理由が述べられていないなら逡巡しても無駄です。
他メンバーの意見を尊重するってのは、忖度しまくることではないと思います。
相手に敬意を表するのと、相手の顔色をうかがうのとは違うと思います。

加えて、修正根拠の「意図しない変更の要因になる」と「意図しない変更が発生することが修正を妨げている」も疑問です。

ドキュメント修正が行われない理由を他に求めると、絶望的です。
なので、そういうことにしておきたいです（笑）。