Refresh README and broaden CI detection#9
Merged
Conversation
Rewrote README to refresh structure and add NuGet badges, a Contents section, clearer package guidance (PinguApps.RazorStyle and PinguApps.RazorStyle.Cli), Build Integration and CLI usage docs, and expanded rule descriptions for RS0001–RS0003. Broadened CI detection guidance so ContinuousIntegrationBuild is documented to auto-enable for GitHub Actions, Azure DevOps (TF_BUILD), generic CI=true, TeamCity, and Jenkins. Added .diary/docs-refresh.md capturing the session log and next actions. No production or test code was changed; this commit is purely documentation and build guidance updates.
Expand ContinuousIntegrationBuild logic to detect multiple CI environments (GITHUB_ACTIONS, TF_BUILD, CI, TEAMCITY_VERSION, JENKINS_URL) and only set it to true when not already defined. Previously it only checked GITHUB_ACTIONS; this prevents overriding an explicit setting and ensures builds on various CI systems are recognized.
Group and reformat the README badges into a Markdown table to separate CLI tool and build package badges into Version/Downloads rows. Also record the docs refresh entry in .diary/docs-refresh.md with timestamp and brief rationale. (files: README.md, .diary/docs-refresh.md)
Pull Request Test Results20 tests 20 ✅ 0s ⏱️ Results for commit 03c8666. |
There was a problem hiding this comment.
Pull request overview
This PR refreshes the project’s documentation and clarifies CI/build integration behavior for RazorStyle, primarily by rewriting the README and expanding CI detection logic at the repo build-props level.
Changes:
- Rewrote
README.mdto improve package guidance, add a contents section, reorganize build vs CLI usage instructions, and expand rule explanations. - Broadened
ContinuousIntegrationBuildauto-detection inDirectory.Build.propsto cover multiple CI providers (andCI=true) when not explicitly set. - Added a
.diaryentry documenting the motivation and steps taken for the docs/CI refresh.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | New structure, badges table, clearer usage guidance (build integration + CLI), and richer rule descriptions. |
| Directory.Build.props | Expanded conditional logic that sets ContinuousIntegrationBuild based on common CI environment variables. |
| .diary/docs-refresh.md | Session notes/log for the docs and CI detection updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Categorise the PR
featurebugdocssecuritymetapatchminormajorSummary
This pull request focuses on improving the documentation and build integration guidance for RazorStyle, with no changes to production or test code. The main updates are a complete rewrite of the
README.mdfor clarity and usability, and enhancements to CI build detection inDirectory.Build.props.Documentation improvements:
README.mdto include a clear package comparison table with grouped badges, a contents section, detailed package usage guidance, build integration instructions, CLI usage examples, and richer descriptions of each linting rule. [1] [2] [3] [4] [5]README.mdto display version and download counts grouped by package type for better readability.Build and CI integration:
Directory.Build.propsso thatContinuousIntegrationBuildis enabled for GitHub Actions, Azure DevOps, TeamCity, Jenkins, and any environment withCI=true, unless explicitly set. This ensures consistent behaviour across common CI providers.Process documentation:
.diary/docs-refresh.mdfile summarizing the motivation, plan, and session log for the documentation and CI improvements.