Skip to content

Free, open-source Windows optimization tool for performance, privacy, and simplicity.

docs(contributing): use csharpier <command> syntax

fatDuck8c2a35fc5501
diff --git a/.github/contributing/CONTRIBUTING.ja-JP.md b/.github/contributing/CONTRIBUTING.ja-JP.md
index 7898dcd..0509c9c 100644
--- a/.github/contributing/CONTRIBUTING.ja-JP.md
+++ b/.github/contributing/CONTRIBUTING.ja-JP.md
@@ -77,7 +77,7 @@ dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj --configuration Release
dotnet run --project optimizerDuck/optimizerDuck.csproj
# CSharpier でコードを整形
-dotnet csharpier .
+csharpier format .
```
> 新しい NuGet 依存関係を追加した場合は、再度 `dotnet restore` を実行してください(以降のビルドでは `--no-restore` を使用します)。
@@ -100,7 +100,7 @@ publish.bat portable --no-pause # 最後に一時停止しない(CI 向け
- [ ] リポジトリをフォークしてクローンする
- [ ] `dotnet build` が成功する(エラー 0 件)
- [ ] `dotnet test` が通る(すべてのテストが成功)
-- [ ] `dotnet csharpier .` がエラーなく整形できる
+- [ ] `csharpier format .` がエラーなく整形できる(`csharpier check .` で検証)
- [ ] 下記の [アーキテクチャ概要](#architecture-overview) を読む
---
@@ -1158,7 +1158,7 @@ public class MyOptimizationTests
| 最大行長 | 100 文字 |
| 末尾の空白 | 削除 |
| 末尾の改行 | 必須 |
-| フォーマッター | **CSharpier** — コミット前に `dotnet csharpier .` |
+| フォーマッター | **CSharpier** — コミット前に `csharpier format .`(`csharpier check .` で検証) |
| CA1416 | `.editorconfig` で抑制 — すべて Windows 専用 |
<h3 id="code-style-jp">コードスタイル</h3>
@@ -1311,7 +1311,7 @@ XAML:
dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj --configuration Release --no-build
# 3. 整形
- dotnet csharpier .
+ csharpier format .
# 4. git status を確認 — 意図したファイルだけがステージされていることを確認
git status
@@ -1333,7 +1333,7 @@ XAML:
- [ ] 関連する場合は条件が宣言されている([条件システム](#the-condition-system) を参照)
- [ ] `dotnet build` が成功(エラー 0 件)
- [ ] `dotnet test` が成功(全テスト緑)
-- [ ] `dotnet csharpier .` を実行済み
+- [ ] `csharpier format .` を実行済み(`csharpier check .` で検証)
- [ ] ハードコード文字列なし
- [ ] リバートステップが適切に記録されている(該当する場合)
- [ ] UI 変更のスクリーンショットあり
diff --git a/.github/contributing/CONTRIBUTING.tr-TR.md b/.github/contributing/CONTRIBUTING.tr-TR.md
index ae5c528..6d89b1a 100644
--- a/.github/contributing/CONTRIBUTING.tr-TR.md
+++ b/.github/contributing/CONTRIBUTING.tr-TR.md
@@ -77,7 +77,7 @@ dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj --configuration Release
dotnet run --project optimizerDuck/optimizerDuck.csproj
# CSharpier ile kodu biçimlendir
-dotnet csharpier .
+csharpier format .
```
> Yeni NuGet bağımlılıkları eklerseniz, `dotnet restore` komutunu tekrar çalıştırın (sonraki derlemelerde `--no-restore` kullanabilirsiniz).
@@ -100,7 +100,7 @@ publish.bat portable --no-pause # Sonunda duraklamaz (CI dostu)
- [ ] Depoyu forkladınız ve klonladınız
- [ ] `dotnet build` başarılı oldu (0 hata)
- [ ] `dotnet test` geçer (tüm testler yeşil)
-- [ ] `dotnet csharpier .` hatasız şekilde kodunuzu biçimlendiriyor
+- [ ] `csharpier format .` hatasız şekilde kodunuzu biçimlendiriyor (`csharpier check .` ile doğrulayın)
- [ ] Aşağıdaki [Mimariye Genel Bakış](#architecture-overview) bölümünü okudunuz
---
@@ -1159,7 +1159,7 @@ public class MyOptimizationTests
| Maksimum satır uzunluğu | 100 karakter |
| Sondaki boşluk | Kırpılır |
| Sondaki yeni satır | Zorunlu |
-| Biçimlendirici | **CSharpier** — commit öncesi `dotnet csharpier .` çalıştırın |
+| Biçimlendirici | **CSharpier** — commit öncesi `csharpier format .` çalıştırın (`csharpier check .` ile doğrulayın) |
| CA1416 | `.editorconfig` ile susturulur — tüm kod Windows'a özeldir |
<h3 id="code-style-tr">Kod Stili</h3>
@@ -1312,7 +1312,7 @@ XAML içinde:
dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj --configuration Release --no-build
# 3. Biçimlendir
- dotnet csharpier .
+ csharpier format .
# 4. git status'u kontrol edin — yalnızca amaçlanan dosyaların aşamalandığından emin olun
git status
@@ -1334,7 +1334,7 @@ XAML içinde:
- [ ] İlgiliyse koşullar bildirildi ([Koşul Sistemi](#the-condition-system) bölümüne bakın)
- [ ] `dotnet build` başarılı (0 hata)
- [ ] `dotnet test` geçiyor (tüm testler yeşil)
-- [ ] `dotnet csharpier .` çalıştırıldı
+- [ ] `csharpier format .` çalıştırıldı (`csharpier check .` ile doğrulayın)
- [ ] Sabit kodlanmış dize yok
- [ ] Geri alma adımları düzgün kaydedildi (geçerliyse)
- [ ] UI değişiklikleri bir ekran görüntüsü içeriyor
diff --git a/AGENTS.md b/AGENTS.md
index d5c21cd..8bb9023 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -14,7 +14,7 @@
- `dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj --configuration Release --no-build --filter "FullyQualifiedName~TestName"` — run a single test.
- `dotnet run --project optimizerDuck/optimizerDuck.csproj` — run locally (needs admin).
- `publish.bat portable` or `publish.bat single --skip-tests` — create release artifacts.
-- `dotnet csharpier .` — format all code with CSharpier.
+- `csharpier format .` — format all code with CSharpier (`csharpier check .` to verify without writing).
## Project Structure
- `optimizerDuck/` — WPF app (single project, no sub-projects):
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b1bc822..91c8a26 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -77,7 +77,7 @@ dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj --configuration Release
dotnet run --project optimizerDuck/optimizerDuck.csproj
# Format code with CSharpier
-dotnet csharpier .
+csharpier format .
```
> If you add new NuGet dependencies, run `dotnet restore` again (then `--no-restore` for subsequent builds).
@@ -100,7 +100,7 @@ Before your first contribution:
- [ ] Fork + clone the repo
- [ ] `dotnet build` succeeds (0 errors)
- [ ] `dotnet test` passes (all tests green)
-- [ ] `dotnet csharpier .` formats without errors
+- [ ] `csharpier format .` formats without errors (`csharpier check .` to verify)
- [ ] Read the [Architecture Overview](#architecture-overview) below
---
@@ -1157,7 +1157,7 @@ public class MyOptimizationTests
| Max line length | 100 characters |
| Trailing whitespace | Trimmed |
| Final newline | Required |
-| Formatter | **CSharpier** — run `dotnet csharpier .` before committing |
+| Formatter | **CSharpier** — run `csharpier format .` before committing (`csharpier check .` to verify) |
| CA1416 | Silenced via `.editorconfig` — all code is Windows-only |
### Code Style
@@ -1310,7 +1310,7 @@ In XAML:
dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj --configuration Release --no-build
# 3. Format
- dotnet csharpier .
+ csharpier format .
# 4. Check git status — make sure only intended files are staged
git status
@@ -1332,7 +1332,7 @@ In XAML:
- [ ] Conditions declared where relevant (see [The Condition System](#the-condition-system))
- [ ] `dotnet build` succeeds (0 errors)
- [ ] `dotnet test` passes (all tests green)
-- [ ] `dotnet csharpier .` has been run
+- [ ] `csharpier format .` has been run (`csharpier check .` to verify)
- [ ] No hardcoded strings
- [ ] Revert steps are properly recorded (if applicable)
- [ ] UI changes include a screenshot