Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 2.24 KB
Raw

Contributing to Milvus-sdk-node

We appreciate your interest in contributing to Milvus SDK Node! This document outlines the guidelines and processes you should follow when contributing to the project.

Table of Contents

Code of Conduct

Milvus SDK Node has adopted a Code of Conduct that we expect all contributors to follow. Please read the code of conduct before contributing.

How to Contribute

Reporting Bugs

If you find a bug in the code, please report it by opening an issue in the issue tracker. Please include a clear and concise description of the problem, along with any steps you took to reproduce it.

Feature Requests

If you have a feature request, please open an issue in the issue tracker. Please include a clear and concise description of the feature you would like to see.

Pull Requests

If you would like to contribute code to Milvus SDK Node, please submit a pull request. Here are the steps to follow:

  1. Fork the repository and create a new branch from main.
  2. Make your changes and write unit tests if applicable.
  3. Run the tests by executing npm test from the project root.
  4. Commit your changes and push your branch to your fork.
  5. Open a pull request against the main branch of the Milvus SDK Node repository.

Your pull request will be reviewed by the maintainers, and we may request changes before merging.

Development Setup

Here's how you can set up a development environment for Milvus SDK Node:

  1. Install Node.js and npm if you haven't already.
  2. Clone the repository: git clone https://github.com/milvus-io/milvus-sdk-node.git.
  3. Install the dependencies by running npm install from the project root.
  4. You're ready to start developing!

License

Milvus SDK Node is licensed under the Apache License, Version 2.0. By contributing to this project, you agree to license your contributions under the same license.