Skip to content
MilvusNode SDK
Sections

Contributing

Markdown

Copy for agent

Thank you for your interest in contributing to the Milvus Node.js SDK!

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.

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/ # Documentation
  • milvus/MilvusClient.ts: Main client class
  • milvus/grpc/: gRPC implementation
  • milvus/http/: HTTP implementation
  • milvus/types/: TypeScript type definitions

When adding features:

  1. Update relevant documentation files
  2. Add code examples
  3. Update API reference if needed
  • docs/src/content/docs/: Documentation source files
  • Use MDX format
  • Include code examples

Include:

  • SDK version
  • Node.js version
  • Steps to reproduce
  • Expected vs actual behavior
  • Error messages/logs

Include:

  • Use case description
  • Proposed solution
  • Benefits

Please follow the Code of Conduct.

Install the documentation dependencies separately from SDK dependencies:

Terminal window
yarn --cwd docs install --frozen-lockfile
npm run doc
npm run doc:dev

The 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.