Skip to content

chore: Create read-me files for each package#225

Merged
skarllot merged 2 commits intomainfrom
feat/readme-nuget
Feb 12, 2026
Merged

chore: Create read-me files for each package#225
skarllot merged 2 commits intomainfrom
feat/readme-nuget

Conversation

@skarllot
Copy link
Copy Markdown
Owner

@skarllot skarllot commented Feb 12, 2026

Pull Request

The issue or feature being addressed

  • HTML tags are not supported in NuGet read-me files
  • NuGet read-me file shows information of other packages

Details on the issue fix or feature implementation

  • Create read-me file for each package

Confirm the following

  • I started this PR by branching from the head of the default branch
  • I have targeted the PR to merge into the default branch
  • I have included unit tests for the issue/feature
  • I have successfully run a local build

Summary by CodeRabbit

  • Documentation
    • Added comprehensive README documentation for InterpolationCodeWriter, InterpolationCodeWriter.CSharp, and InterpolationCodeWriter.CSharp.Sources with installation steps, Quick Start examples, feature descriptions, compatibility notes, and license information.
  • Chores
    • Updated build configuration to change how the README is resolved during packaging (now referenced relatively).

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 12, 2026

📝 Walkthrough

Walkthrough

Updated MSBuild props to change how README.md is referenced for packaging and added three new README files documenting InterpolationCodeWriter packages (core, CSharp integration, and CSharp sources) with usage, installation, and compatibility details.

Changes

Cohort / File(s) Summary
Build configuration
src/Directory.Build.props
Changed README inclusion path in the None ItemGroup from $(SolutionDir)README.md to README.md.
Package documentation
src/InterpolationCodeWriter/README.md, src/InterpolationCodeWriter.CSharp/README.md, src/InterpolationCodeWriter.CSharp.Sources/README.md
Added new README files for each package containing project descriptions, installation instructions, Quick Start examples, compatibility notes, and links to docs/license.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nibble lines of README cheer,

New docs hop in, now crystal clear.
A path adjusted, tidy and neat,
Packages ready — what a treat! 🎉

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main objective of the changeset: creating README files for each package, which directly corresponds to the four README.md files added/modified in the PR.
Description check ✅ Passed The description covers the required template sections with good detail: it identifies the problem (HTML tag support and cross-package content issues), explains the solution (separate README per package), and completes the confirmation checklist appropriately.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/readme-nuget

No actionable comments were generated in the recent review. 🎉


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@src/InterpolationCodeWriter.CSharp.Sources/README.md`:
- Around line 17-40: The README's Quick Start names both ICodeWriter<T> and
CodeWriterDispatcher<T> but only shows an ICodeWriter<T> example; update the doc
so the text matches the sample by either (A) adding a short snippet that
demonstrates creating and using a CodeWriterDispatcher<T> with the MyWriter
implementation (show registering MyWriter with CodeWriterDispatcher<T> and
invoking dispatch) or (B) removing CodeWriterDispatcher<T> from the sentence so
it only references ICodeWriter<T>; locate references to ICodeWriter<T>,
CodeWriterDispatcher<T>, and the MyWriter example to adjust the content
accordingly.

Comment thread src/InterpolationCodeWriter.CSharp.Sources/README.md
@skarllot skarllot merged commit 2c2b906 into main Feb 12, 2026
5 checks passed
@skarllot skarllot deleted the feat/readme-nuget branch February 12, 2026 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants