Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 2.78 KB

README.md

File metadata and controls

70 lines (40 loc) · 2.78 KB

メンテナー向けドキュメント

考え方

目指しているもの

  • 問題の起きにくいコードを書く手助けになる
  • 一定のトレンドをおさえたコードを書く手助けになる

目指していないもの

  • 特定のフレームワークなどに特化した指定

コーディングスタイル

このパッケージがコーディングスタイルを細かく指定しているのは、コーディングスタイルが揺れたまま作業すると差分が分かりにくくなる、競合が起こりやすくなるなどのデメリットを避けるためです。

このパッケージのコーディングスタイルが絶対的に正しいとは考えていません。単に揺れを抑えているにすぎません。

同様に、他のコーディングスタイルにも敬意ははらっていますが、絶対的に正しいと考えることはなく、積極的な変更は予定していません。

コーディングスタイルに関する変更を行わないというわけではありませんが、提案をされる際にはメリットやデメリットを具体的にお書きくださるようお願いします。

バージョン

チェック対象のコードを変えずにパッケージを更新すると新しいエラーが報告されるようになる場合、メジャーバージョンを変更します(1.0.0を2.0.0に変更)。

チェック対象のコードを変えずにパッケージを更新すると新しい警告が報告されるようになる場合、マイナーバージョンを変更します(1.1.0を1.1.0に変更)。

そうでなければ、パッチバージョンを変更します(1.0.0を1.0.1に変更)。

メンテナンス

このリポジトリではnpm workspacesを利用しています。以下のコマンドを実行すると各パッケージの準備が完了します。

npm ci

このリポジトリではGit Flowは採用していません。mainブランチが常に正です。ブランチはmainから切り出し、マージリクエストもmainに対して出してください。リリースできない状態のものはmainブランチにはマージしないでください。

コミットメッセージ

Conventional Commitsを採用しています。基本的には以下の形式でコミットメッセージを書きます。

<type>: (概要)

コミットメッセージ

例:

feat: es2020の有効化

詳しい説明

後方互換性のない変更の例:

feat: arrow-body-styleの有効化

BREAKING CHANGE: 詳しい説明

リンター固有のドキュメント