Preserve dotnet new bit-bp parameters while creating project for further references (#11252)

[ysmoradi]

closes #11252

Summary by CodeRabbit

• Documentation
  • Updated the README to provide a detailed example command for generating a project with various configuration flags.
  • Clarified how different parameters affect command-line options in the template example.
• Chores
  • Removed a version comment from a configuration file for cleanliness.

[coderabbitai]

Walkthrough

A detailed example command with conditional flags was added to the Bit.Boilerplate template's README.md to illustrate project generation options. Additionally, an XML comment indicating the template version was removed from Directory.Build.props. No code logic or public entity declarations were changed.

Changes

Cohort / File(s)	Change Summary
README Update src/Templates/Boilerplate/Bit.Boilerplate/README.md	Added an example command demonstrating usage of conditional flags for project generation; minor whitespace cleanup.
Props File Cleanup src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props	Removed template version XML comment at the top of the file; no other modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Preserve and document dotnet new bit-bp command parameters for further references (#11252)	✅

Poem

A bunny hopped through docs and code,
Tidying props, making README explode—
With flags and examples, so clear and bright,
Now new projects launch just right!
No version clutter left to see,
Just templates, crisp as they can be.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

src/Templates/Boilerplate/Bit.Boilerplate/README.md (2)

62-64: Boolean parameter is shown only for the false case – may be misleading

Every other boolean flag (aspire, notification, sample, …) is listed when its value is true.
cloudflare is the single exception (--cloudflare false). If the intent is to demonstrate turning it on, mirror the pattern used above; if the intent is to demonstrate that it can be disabled, add a short inline comment to avoid confusion.

---

7-68: Consider collapsing the long conditional command for readability

The exhaustive list of --flag permutations is useful for template authors but may overwhelm end-users skimming the README. A shorter example plus a link to full docs (or a collapsible <details> block) keeps the file concise while still exposing the information.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 4b1645c and 5ae5690.

📒 Files selected for processing (2)

• src/Templates/Boilerplate/Bit.Boilerplate/README.md (2 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props (0 hunks)

💤 Files with no reviewable changes (1)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build and test