Update documentation with comprehensive development guidelines #32
Conversation
- Add detailed TDD workflow and testing requirements to CLAUDE.md - Include mandatory test execution and incremental development guidelines - Enhance README.md with development setup and testing instructions - Add comprehensive contribution guidelines with testing requirements - Clarify when tests are required vs optional for different types of work - Document test simulation framework and best practices 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
WalkthroughThe updates overhaul and expand the project's documentation, focusing on enforcing a strict test-driven development (TDD) workflow and comprehensive testing guidelines. Both CLAUDE.md and README.md are revised to clarify mandatory testing practices, development setup, code quality requirements, and contribution steps, with detailed instructions for running tests and maintaining code standards. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant LocalEnv
participant Meilisearch
participant TestSuite
participant Repo
Developer->>LocalEnv: Set up environment (install tools, start Meilisearch)
Developer->>LocalEnv: Write failing test (TDD)
Developer->>LocalEnv: Implement minimal code to pass test
Developer->>TestSuite: Run all tests locally
TestSuite->>Meilisearch: Interact with running instance (test isolation)
TestSuite-->>Developer: Report results
Developer->>LocalEnv: Refactor code
Developer->>TestSuite: Re-run tests (ensure passing)
Developer->>LocalEnv: Format code (Black), check types/lint
Developer->>Repo: Commit and push small, atomic changes
Possibly related PRs
Poem
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
CLAUDE.md (3)
7-7: Use "whether" for formality
Replace "assess if tests are needed" with "assess whether tests are needed" for a more formal tone.- **Before starting any task, agents MUST assess if tests are needed for the work requested.** + **Before starting any task, agents MUST assess whether tests are needed for the work requested.**
153-154: Remove trailing punctuation in heading
Headings should not end with punctuation per markdown style.- #### When Tests are REQUIRED: + #### When Tests are REQUIRED🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
154-154: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
160-161: Remove trailing punctuation in heading
Apply the same change for the optional tests heading.- #### When Tests are OPTIONAL: + #### When Tests are OPTIONAL🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
161-161: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
README.md (1)
193-193: Ensure consistent module invocation syntax
Use dot notation for module invocation to match other commands (python -m src.meilisearch_mcp), rather than a file path.- npx @modelcontextprotocol/inspector python -m src/meilisearch_mcp + npx @modelcontextprotocol/inspector python -m src.meilisearch_mcp
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CLAUDE.md(3 hunks)README.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
CLAUDE.md
[style] ~52-~52: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ...coverage ``` **
(IF_WHETHER)
README.md
[duplication] ~284-~284: Possible typo: you repeated a word.
Context: ...ines - All new features should include tests - Tests should pass before submitting PRs - Use...
(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
CLAUDE.md
154-154: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
161-161: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (2)
CLAUDE.md (1)
1-240: Documentation enhancements are thorough and well-structured.
The new TDD workflow and testing guidelines align with project objectives.🧰 Tools
🪛 LanguageTool
[style] ~52-~52: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ...coverage ``` **⚠️ Never commit or push if tests are failing or not written for ne...(IF_WHETHER)
🪛 markdownlint-cli2 (0.17.2)
111-111: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
154-154: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
161-161: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
README.md (1)
1-293: README additions provide clear setup, testing, and contribution guidelines.
Overall documentation is comprehensive and consistent with CLAUDE.md.🧰 Tools
🪛 LanguageTool
[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...at runtime: -get-connection-settings: View current connection URL and API key...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~138-~138: Loose punctuation mark.
Context: ...h across one or all indices: -search: Search through Meilisearch indices with...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~284-~284: Possible typo: you repeated a word.
Context: ...ines - All new features should include tests - Tests should pass before submitting PRs - Use...(ENGLISH_WORD_REPEAT_RULE)
Summary
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit