Skip to content

Conformance: modernize CODESTYLE.md to the template structure #13

Description

@ptr727

Context

This repo's CODESTYLE.md predates the template's General/.NET/Python restructure (ptr727/ProjectTemplate CODESTYLE.md). Its content still works but the organization has diverged, only because the template restructure was never propagated here. (The narrow spelling-rule fix — US-English + CI scope — already landed in #11.)

Goal

Reorganize CODESTYLE.md into the template's structure — General + .NET (this repo is csharp / console / docker) — adapted to this repo's actuals. Do NOT copy the template verbatim: it describes the template's own specifics.

This repo's actuals (make the doc match reality)

  • VS Code task labels are .Net Build / .Net Format (this repo's casing), not the template's .NET .... Keep doc and .vscode/tasks.json consistent (match one to the other).
  • Confirm the actual analyzer settings in the .csproj/props — the template asserts <AnalysisMode>All</AnalysisMode> + <TreatWarningsAsErrors>true</TreatWarningsAsErrors>; only state what this repo really sets.
  • PhotoCleaner.code-workspace currently holds a cSpell.words list; the template rule says the word list must live in cspell.json. Reconcile (move it) or describe the actual setup.
  • Tests use Assert.Skip(...) to skip when external tools are unavailable — the template forbids native xUnit asserts; carve out this legitimate exception or adjust the rule text.
  • The template's LanguageTags / LogOptions code examples don't exist here — replace with repo-real examples or mark as illustrative.
  • Markdown here is CRLF (.editorconfig); keep any rewrite CRLF.

Reference

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions