Contributing
Thank you for your interest in contributing to the Milvus Node.js SDK!
Develop and submit a change
Section titled “Develop and submit a change”Use the repository contribution guide for development setup, test commands, and the pull request process. It explains how to install the locked dependencies, initialize the pinned protobuf sources, and sign off each commit for DCO.
For SDK changes, run the relevant tests under test2/ and report the results in your pull request. The test suite guide covers unit tests, server-backed tests, the npm package lifecycle, and the coverage gate.
Code Structure
Section titled “Code Structure”Directory Structure
Section titled “Directory Structure”milvus-sdk-node/├── milvus/ # Main SDK code│ ├── grpc/ # gRPC client│ ├── http/ # HTTP client│ ├── types/ # TypeScript types│ └── utils/ # Utilities├── test2/ # Tests├── benchmarks/ # Manual performance benchmarks├── examples/ # Examples└── docs/ # DocumentationKey Files
Section titled “Key Files”milvus/MilvusClient.ts: Main client classmilvus/grpc/: gRPC implementationmilvus/http/: HTTP implementationmilvus/types/: TypeScript type definitions
Documentation
Section titled “Documentation”Update Documentation
Section titled “Update Documentation”When adding features:
- Update relevant documentation files
- Add code examples
- Update API reference if needed
Documentation Structure
Section titled “Documentation Structure”docs/src/content/docs/: Documentation source files- Use MDX format
- Include code examples
Reporting Issues
Section titled “Reporting Issues”Bug Reports
Section titled “Bug Reports”Include:
- SDK version
- Node.js version
- Steps to reproduce
- Expected vs actual behavior
- Error messages/logs
Feature Requests
Section titled “Feature Requests”Include:
- Use case description
- Proposed solution
- Benefits
Code of Conduct
Section titled “Code of Conduct”Please follow the Code of Conduct.
Getting Help
Section titled “Getting Help”Next Steps
Section titled “Next Steps”- Read Best Practices
- Check API Reference
- Explore Examples & Tutorials
Build and preview the documentation site
Section titled “Build and preview the documentation site”Install the documentation dependencies separately from SDK dependencies:
yarn --cwd docs install --frozen-lockfilenpm run docnpm run doc:devThe site uses Astro/Starlight and writes production output to docs/out/. Edit MDX under docs/src/content/docs/; npm run doc preserves these source files. For production preview, run npm --prefix docs run preview after building. Use Node.js 22.23.4 or newer for the current locked Astro version; the documentation toolchain can require a newer runtime than the SDK.
The production build checks internal links and heading fragments against the generated pages and verifies canonical URLs, metadata, and the sitemap.
When releasing, compare the published tag with the last documented version, update guides and API reference, add release notes, and synchronize README compatibility and llms.txt. Verify example imports against package exports.