Skip to content
MilvusNode SDK
API ReferenceZilliz CloudMilvusAttu

Contributing

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

Development Setup

Section titled “Development Setup”

Prerequisites

Section titled “Prerequisites”
  • Node.js 18+
  • Yarn package manager
  • Git

Clone Repository

Section titled “Clone Repository”
Terminal window
git clone https://github.com/milvus-io/milvus-sdk-node.git
cd milvus-sdk-node

Install Dependencies

Section titled “Install Dependencies”
Terminal window
yarn install

Fetch Milvus Proto

Section titled “Fetch Milvus Proto”
Terminal window
# Initialize submodules (first time)
git submodule init


# Update submodules
git submodule update --remote

Build

Section titled “Build”
Terminal window
yarn build

Testing

Section titled “Testing”

Run Tests

Section titled “Run Tests”
Terminal window
# Run all tests
yarn test


# Run specific test file
yarn test -- test/Collection.spec.ts


# Run with coverage
yarn coverage

Test Structure

Section titled “Test Structure”

Tests are located in the test/ directory:

  • test/grpc/: gRPC client tests
  • test/http/: HTTP client tests
  • test/utils/: Utility tests

Code Style

Section titled “Code Style”

TypeScript

Section titled “TypeScript”
  • Use TypeScript strict mode
  • Follow existing code style
  • Use meaningful variable names
  • Add JSDoc comments for public APIs

Formatting

Section titled “Formatting”

Code is automatically formatted. Ensure your editor uses the project’s formatting settings.

Linting

Section titled “Linting”
Terminal window
# Check linting
yarn lint

Adding Features

Section titled “Adding Features”

1. Create Feature Branch

Section titled “1. Create Feature Branch”
Terminal window
git checkout -b feature/your-feature-name

2. Implement Feature

Section titled “2. Implement Feature”
  • Add code in appropriate directory
  • Write tests for your feature
  • Update documentation if needed

3. Test Your Changes

Section titled “3. Test Your Changes”
Terminal window
yarn test
yarn build

4. Commit Changes

Section titled “4. Commit Changes”

Follow conventional commit format:

feat: add new feature
fix: fix bug
docs: update documentation
test: add tests

5. Push and Create PR

Section titled “5. Push and Create PR”
Terminal window
git push origin feature/your-feature-name

Then create a pull request on GitHub.

Pull Request Process

Section titled “Pull Request Process”

Before Submitting

Section titled “Before Submitting”
  1. Update Tests: Ensure all tests pass
  2. Update Documentation: Add/update docs for new features
  3. Check Linting: Fix any linting errors
  4. Review Changes: Review your own changes

PR Requirements

Section titled “PR Requirements”
  • Clear description of changes
  • Reference to related issues
  • Tests for new features
  • Documentation updates

Review Process

Section titled “Review Process”
  • Maintainers will review your PR
  • Address any feedback
  • Once approved, your PR will be merged

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
├── test/            # Tests
├── examples/        # Examples
└── docs/           # Documentation

Key Files

Section titled “Key Files”
  • milvus/MilvusClient.ts: Main client class
  • milvus/grpc/: gRPC implementation
  • milvus/http/: HTTP implementation
  • milvus/types/: TypeScript type definitions

Testing Guidelines

Section titled “Testing Guidelines”

Write Tests

Section titled “Write Tests”
  • Test happy paths
  • Test error cases
  • Test edge cases
  • Mock external dependencies

Test Example

Section titled “Test Example”
describe('createCollection', () => {
  it('should create collection successfully', async () => {
    const result = await client.createCollection({
      collection_name: 'test_collection',
      fields: schema,
    });


    expect(result.error_code).toBe('Success');
  });
});

Documentation

Section titled “Documentation”

Update Documentation

Section titled “Update Documentation”

When adding features:

  1. Update relevant documentation files
  2. Add code examples
  3. 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”

Build and preview the documentation site

Section titled “Build and preview the documentation site”

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.12.0 or newer, as required by the installed Astro version; the documentation toolchain can require a newer runtime than the SDK.

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 and check site links after building.