Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

docs: Added READMEs - #122

#122
Merged
samtrion merged 2 commits into
maindailydevops/projectbuilders:mainfrom
docs/readmedailydevops/projectbuilders:docs/readmeCopy head branch name to clipboard
Mar 30, 2026
Merged

docs: Added READMEs#122
samtrion merged 2 commits into
maindailydevops/projectbuilders:mainfrom
docs/readmedailydevops/projectbuilders:docs/readmeCopy head branch name to clipboard

Conversation

@samtrion

@samtrion samtrion commented Mar 30, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Expanded root README with a full project overview, badges, installation/prerequisites, build/test/format commands, repository structure, architecture notes, versioning, contributing/support links, and MIT license
    • Added TUnit package README with purpose, features, installation instructions, usage examples, requirements, and support/contributing links
    • Added XUnit package README with purpose, features, installation instructions, usage examples, requirements, and support/contributing links

@samtrion samtrion self-assigned this Mar 30, 2026
@samtrion samtrion added state:ready for merge Indicates that a pull request has been reviewed and approved, and is ready to be merged into the mai type:chore Indicates some housework that needs to be done. labels Mar 30, 2026
@coderabbitai

coderabbitai Bot commented Mar 30, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c67ae641-5bc3-49e4-b405-39dc767f0e4d

📥 Commits

Reviewing files that changed from the base of the PR and between a47464c and 64d57de.

📒 Files selected for processing (2)
  • src/NetEvolve.ProjectBuilders.TUnit/README.md
  • src/NetEvolve.ProjectBuilders.XUnit/README.md

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting


Walkthrough

Replaced the template README with a full ProjectBuilders repository README and added two package-specific READMEs for NetEvolve.ProjectBuilders.TUnit and NetEvolve.ProjectBuilders.XUnit documenting features, installation, and usage examples.

Changes

Cohort / File(s) Summary
Main Repository Documentation
README.md
Replaced minimal template content with a comprehensive ProjectBuilders README: badges, overview, project list, features, prerequisites, install/build/test/format commands, repository folder structure, architecture notes, contributing/code-of-conduct/docs links, GitVersion/versioning note, support links, and MIT license.
Package-Specific Documentation
src/NetEvolve.ProjectBuilders.TUnit/README.md, src/NetEvolve.ProjectBuilders.XUnit/README.md
Added new READMEs for TUnit and XUnit packages: package descriptions, feature lists, installation (NuGet CLI, dotnet add, PackageReference), .NET 8.0+ requirement, quick-start usage examples (TemporaryDirectory/ClassDataSource and IClassFixture patterns), related package links, contributing/support/license sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I nibble docs and tidy trails,

README blooms with helpful tales,
TUnit, XUnit — cozy nooks,
Tests find homes in tidy books,
Hoppity hop, the guide now sails ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: Added READMEs' accurately describes the primary changes—adding three new README.md files to the repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/NetEvolve.ProjectBuilders.TUnit/README.md`:
- Around line 37-57: Update the README examples to reflect the actual
TemporaryDirectory API and lifecycle: replace direct new TemporaryDirectory()
usage with TUnit's data-source/constructor injection (e.g.,
ClassDataSource<TemporaryDirectory> and a test class constructor parameter like
TemporaryDirectory directory), reference directory.FullPath (not Path), and show
using TemporaryDirectory methods such as CreateFile and GetFilePath inside a
test method (and demonstrate disposing via the test lifecycle or using statement
around returned streams) so examples match the TemporaryDirectory class and
TUnit initialization model.

In `@src/NetEvolve.ProjectBuilders.XUnit/README.md`:
- Around line 37-67: The README examples reference a non-existent
_fixture.Directory; update both code blocks to use the actual
TemporaryDirectoryFixture API: replace usages of _fixture.Directory with
_fixture.FullPath and demonstrate the builder methods like
_fixture.CreateFile("name"), _fixture.GetFilePath("name") and (if relevant)
_fixture.CreateDirectory("name") so the example shows real, compilable calls to
TemporaryDirectoryFixture.FullPath, CreateFile, GetFilePath and CreateDirectory.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7c44a050-7367-47f8-a5f4-a2f40344f9f6

📥 Commits

Reviewing files that changed from the base of the PR and between e259bb9 and a47464c.

📒 Files selected for processing (3)
  • README.md
  • src/NetEvolve.ProjectBuilders.TUnit/README.md
  • src/NetEvolve.ProjectBuilders.XUnit/README.md

Comment thread src/NetEvolve.ProjectBuilders.TUnit/README.md
Comment thread src/NetEvolve.ProjectBuilders.XUnit/README.md
@codecov

codecov Bot commented Mar 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.46%. Comparing base (e259bb9) to head (64d57de).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #122   +/-   ##
=======================================
  Coverage   70.46%   70.46%           
=======================================
  Files          31       31           
  Lines         738      738           
  Branches       88       88           
=======================================
  Hits          520      520           
  Misses        206      206           
  Partials       12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@samtrion
samtrion merged commit d0f9f72 into main Mar 30, 2026
5 checks passed
@samtrion
samtrion deleted the docs/readme branch March 30, 2026 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

state:ready for merge Indicates that a pull request has been reviewed and approved, and is ready to be merged into the mai type:chore Indicates some housework that needs to be done.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Morty Proxy This is a proxified and sanitized view of the page, visit original site.