docs: update contributing guide - #2051
Conversation
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
|
To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge. |
Clarify project structure and commonly changed areas.
There was a problem hiding this comment.
🟢 Approval recommended
The change is documentation-only and the updated instructions/links appear consistent and well-formed in the rendered Markdown.
Pull request overview
Updates the repository’s contributor documentation to reflect the current development workflow and provide clearer guidance for working with the v4 collections API and the project’s test/lint routines.
Changes:
- Replaces outdated link formatting and adds a short “Project structure” section pointing contributors to commonly modified areas.
- Expands testing instructions with examples for running targeted tests and full local test groups, and clarifies integration test steps.
- Adds explicit “run linters on changed files” commands and updates pull request/CLA guidance (including a corrected internal anchor link).
File summaries
| File | Description |
|---|---|
| CONTRIBUTING.md | Refreshes contributor workflow notes, adds project structure pointers, and improves test/lint/PR instructions. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Fixes #1359
Description
Updates CONTRIBUTING.md with current contributor workflow notes, v4 collection API guidance, project structure pointers, and clearer testing/linting commands.
Testing
python3sanity check that CONTRIBUTING.md is readable and expected anchors are present