Skip to content

Update README.md for cosmosdb-best-practices: enhance skill overview …#212

Open
sajeetharan wants to merge 1 commit into
mainfrom
dev/sajee/readme-updates
Open

Update README.md for cosmosdb-best-practices: enhance skill overview …#212
sajeetharan wants to merge 1 commit into
mainfrom
dev/sajee/readme-updates

Conversation

@sajeetharan

Copy link
Copy Markdown
Collaborator

…and installation instructions

Description

Type of Change

  • 📝 New rule - Adding a new best practice rule
  • ✏️ Rule improvement - Updating an existing rule
  • 🆕 New skill - Adding an entirely new skill
  • 🐛 Bug fix - Fixing an issue with existing content
  • 📚 Documentation - Updating README, CONTRIBUTING, or other docs
  • 🔧 Build/Scripts - Changes to build process or scripts

Checklist

  • I have read the Contributing Guide
  • I ran npm run validate and it passed
  • I ran npm run build to regenerate AGENTS.md (if adding/updating rules)
  • My rule file follows the naming convention: {prefix}-{description}.md
  • My rule includes valid frontmatter (title, impact, tags)

For New Rules

Rule file: skills/cosmosdb-best-practices/rules/_____.md

Category:

Impact level:

Why is this rule important?

Agent Testing

  • Tested with GitHub Copilot
  • Tested with Claude Code
  • Tested with Cursor
  • Tested with other agent: _____
  • N/A (documentation only)

Related Issues

Additional Notes

Copilot AI review requested due to automatic review settings June 19, 2026 12:37
@sajeetharan

Copy link
Copy Markdown
Collaborator Author

@TheovanKraay please take a look and merge this!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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-practices README 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 cd into it. The Copilot copy command uses the cosmosdb-agent-kit/... path (works from the parent directory), but the Claude Code command uses skills/... (only works if you already cd 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 TheovanKraay left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?

@jaydestro

Copy link
Copy Markdown
Contributor

on hold till eval on monolith vs split skills done

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.

4 participants