Improve bit Boilerplate copilot configuration (#11119) #11120
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe changes update the GitHub Copilot configuration for the Bit Boilerplate project by clarifying and refining documentation in the Copilot instructions markdown file and enabling the Copilot Chat Code Search feature in the VSCode workspace settings. No code or exported entities were modified. Changes
Assessment against linked issues
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the boilerplate’s VS Code settings to enable Copilot code search and restructures the Copilot instructions document by renaming headings, refining best practices, and clarifying deepwiki tool usage.
- Enable GitHub Copilot chat code search in
.vscode/settings.json. - Rename and reorganize the Copilot instructions markdown (headings and list structure).
- Update deepwiki command references and modernize C# guideline entries.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Templates/Boilerplate/Bit.Boilerplate/.vscode/settings.json | Added "github.copilot.chat.codesearch.enabled". |
| src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md | Renamed headers, updated best practices list, and standardized deepwiki mcp commands. |
Comments suppressed due to low confidence (2)
src/Templates/Boilerplate/Bit.Boilerplate/.vscode/settings.json:5
- The indentation here doesn’t match surrounding entries; adjust to align with the existing indentation level for consistency.
"github.copilot.chat.codesearch.enabled": true,
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md
Outdated
Show resolved
Hide resolved
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md
Show resolved
Hide resolved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md (3)
3-3: Minor formatting nit – add a blank line after the headingInsert an empty line after
## Key Technologiesto improve readability and avoid edge-case render issues.
36-36: Grammar nit – avoid the possessive form-The deepwiki's `ask_question` mcp tool is essential +The `ask_question` MCP tool from DeepWiki is essential
36-42: Use headings instead of bold for RULE captionsmarkdownlint (MD036) flags
**RULE n:**as “emphasis used instead of a heading”.
Switch to real headings (e.g.### Rule 1) or disable MD036 to improve structure and accessibility.-**RULE 1:** If a task ... +### Rule 1 +If a task ...Also applies to: 47-53, 54-60, 61-67, 68-72
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting
📒 Files selected for processing (2)
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md(3 hunks)src/Templates/Boilerplate/Bit.Boilerplate/.vscode/settings.json(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md
45-45: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
52-52: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
59-59: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
66-66: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ 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
🔇 Additional comments (4)
src/Templates/Boilerplate/Bit.Boilerplate/.vscode/settings.json (1)
5-5: Enabling Copilot Code Search – double-check org-wide consentThe setting forces the feature for everyone who opens the workspace.
Please verify that (1) all contributors have Copilot Chat licences and (2) your security/legal policy allows code-context transmission to GitHub’s servers.src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md (3)
1-1: 👍 Clear, conventional document titleThe new H1 is concise and follows Markdown conventions.
Looks good.
19-19: Renamed section matches its content“Coding Conventions & Best Practices” communicates the intent better.
No further action needed.
31-32: Numbering shift acknowledgedList numbering auto-adjusted after the new bullet – nothing else changed.
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md
Outdated
Show resolved
Hide resolved
…ructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Yaser Moradi <ysmoradi@outlook.com>
1 participant
closes #11119
Summary by CodeRabbit
Documentation
Chores