feat(standards): canonical C#, SQL, Markdown configs (complete the set)#32
feat(standards): canonical C#, SQL, Markdown configs (complete the set)#32WomB0ComB0 wants to merge 1 commit into
Conversation
Closes the config gap left in #31: - dotnet/Directory.Build.props — Nullable, .NET analyzers, code-style-in-build, warnings-as-errors in CI (auto-imported by MSBuild) - sql/.sqlfluff — SQLFluff, Postgres dialect, lower-case keywords/idents - .markdownlint.jsonc — markdownlint tuned for our HTML-hero READMEs config/ now covers every language in docs/standards. Updated the config index + retired the 'not yet templated' note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThree canonical configuration files are added under ChangesCanonical Config Files and Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds canonical configuration files for markdownlint, .NET (Directory.Build.props), and SQLFluff, and updates the README to document these additions. Feedback has been provided to use the American spelling "capitalization" in the SQLFluff configuration to avoid warnings in newer versions, and to suppress the CS1591 warning in the .NET build properties to prevent CI build failures caused by missing XML comments on public members.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| [sqlfluff:rules:capitalisation.keywords] | ||
| capitalisation_policy = lower | ||
|
|
||
| [sqlfluff:rules:capitalisation.identifiers] | ||
| extended_capitalisation_policy = lower |
There was a problem hiding this comment.
In SQLFluff v2.0.0 and later, all rule names and configuration options were renamed from British spelling (capitalisation) to American spelling (capitalization). Using the old spelling will result in configuration warnings or errors in modern SQLFluff versions.
Please update the section headers and configuration keys to use capitalization.
[sqlfluff:rules:capitalization.keywords]
capitalization_policy = lower
[sqlfluff:rules:capitalization.identifiers]
extended_capitalization_policy = lower
| <!-- Treat warnings as errors in CI; keep local dev builds loud-but-green. --> | ||
| <TreatWarningsAsErrors Condition="'$(CI)' == 'true'">true</TreatWarningsAsErrors> | ||
| <GenerateDocumentationFile>true</GenerateDocumentationFile> |
There was a problem hiding this comment.
Enabling <GenerateDocumentationFile>true</GenerateDocumentationFile> globally triggers compiler warning CS1591 (Missing XML comment for publicly visible type or member) for all public APIs. Since <TreatWarningsAsErrors> is enabled in CI, this will break the build for any project containing public members without XML comments (which is common in application projects, controllers, etc.).
It is highly recommended to suppress CS1591 globally so that documentation files are still generated (e.g., for Swagger/OpenAPI) without forcing XML comments on every public member.
<!-- Treat warnings as errors in CI; keep local dev builds loud-but-green. -->
<TreatWarningsAsErrors Condition="'$(CI)' == 'true'">true</TreatWarningsAsErrors>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
1 participant
Closes the config gap from #31. Adds canonical configs for the remaining standards languages:
dotnet/Directory.Build.propssql/.sqlfluff.markdownlint.jsoncconfig/now covers every language indocs/standards/02-languages.md. Index updated; 'not yet templated' note retired. Validated (XML/INI/JSONC parse clean).Summary by CodeRabbit