Update README.md for cosmosdb-best-practices: enhance skill overview …#212
Update README.md for cosmosdb-best-practices: enhance skill overview …#212sajeetharan wants to merge 1 commit into
Conversation
…and installation instructions
|
@TheovanKraay please take a look and merge this! |
There was a problem hiding this comment.
Pull request overview
Updates repository and skill documentation to better reflect the current “monolith + focused skills” structure, including refreshed rule counts, installation guidance, and build/validation commands.
Changes:
- Refreshes
cosmosdb-best-practicesREADME overview (rule counts, positioning vs focused skills) and reorganizes build/validate/contributing guidance. - Replaces the root README’s “Available Skills” section with a catalog of focused skills and adds consolidated build/validate instructions plus updated usage examples.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
skills/cosmosdb-best-practices/README.md |
Updates the skill’s overview/installation/build guidance and modernizes structure/compatibility sections. |
README.md |
Updates the repo-level skill catalog, installation guidance, and adds build/validate + usage examples. |
Comments suppressed due to low confidence (1)
skills/cosmosdb-best-practices/README.md:46
- The manual install steps clone the repo but never
cdinto it. The Copilot copy command uses thecosmosdb-agent-kit/...path (works from the parent directory), but the Claude Code command usesskills/...(only works if you alreadycd cosmosdb-agent-kit). This makes the instructions inconsistent and easy to fail when followed top-to-bottom.
```bash
git clone https://github.com/AzureCosmosDB/cosmosdb-agent-kit.git
cp -r cosmosdb-agent-kit/skills/cosmosdb-best-practices ~/.copilot/skills/
Claude Code
cp -r skills/cosmosdb-best-practices ~/.claude/skills/</details>
TheovanKraay
left a comment
There was a problem hiding this comment.
Looks good, only question I have: you changed Security from CRITICAL to HIGH, but Data Modeling and Partition stayed CRITICAL and Security still has two CRITICAL rules. I'd keep Security at CRITICAL for consistency, unless there was a specific reason to downgrade?
|
on hold till eval on monolith vs split skills done |
…and installation instructions
Description
Type of Change
Checklist
npm run validateand it passednpm run buildto regenerate AGENTS.md (if adding/updating rules){prefix}-{description}.mdtitle,impact,tags)For New Rules
Rule file:
skills/cosmosdb-best-practices/rules/_____.mdCategory:
Impact level:
Why is this rule important?
Agent Testing
Related Issues
Additional Notes