Contributing

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

Development Setup

Prerequisites

Node.js 18+
Yarn package manager
Git

Clone Repository


git clone https://github.com/milvus-io/milvus-sdk-node.git
cd milvus-sdk-node

Install Dependencies


yarn install

Fetch Milvus Proto


# Initialize submodules (first time)
git submodule init
 
# Update submodules
git submodule update --remote

Build


yarn build

Testing

Run Tests


# Run all tests
yarn test
 
# Run specific test file
yarn test -- test/Collection.spec.ts
 
# Run with coverage
yarn coverage

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

TypeScript

Use TypeScript strict mode
Follow existing code style
Use meaningful variable names
Add JSDoc comments for public APIs

Formatting

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

Linting


# Check linting
yarn lint

Adding Features

1. Create Feature Branch


git checkout -b feature/your-feature-name

2. Implement Feature

Add code in appropriate directory
Write tests for your feature
Update documentation if needed

3. Test Your Changes


yarn test
yarn build

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


git push origin feature/your-feature-name

Then create a pull request on GitHub.

Pull Request Process

Before Submitting

Update Tests: Ensure all tests pass
Update Documentation: Add/update docs for new features
Check Linting: Fix any linting errors
Review Changes: Review your own changes

PR Requirements

Clear description of changes
Reference to related issues
Tests for new features
Documentation updates

Review Process

Maintainers will review your PR
Address any feedback
Once approved, your PR will be merged

Code Structure

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

milvus/MilvusClient.ts: Main client class
milvus/grpc/: gRPC implementation
milvus/http/: HTTP implementation
milvus/types/: TypeScript type definitions

Testing Guidelines

Write Tests

Test happy paths
Test error cases
Test edge cases
Mock external dependencies

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

Update Documentation

When adding features:

Update relevant documentation files
Add code examples
Update API reference if needed

Documentation Structure

docs/content/: Documentation source files
Use MDX format
Include code examples

Reporting Issues

Bug Reports

Include:

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

Feature Requests