Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shanghaikid authored May 8, 2023
1 parent 5eff9e1 commit e3040a0
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 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](#code-of-conduct)
- [How to Contribute](#how-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Feature Requests](#feature-requests)
- [Pull Requests](#pull-requests)
- [Development Setup](#development-setup)
- [License](#license)

## 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](CODE_OF_CONDUCT.md) 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](https://github.com/milvus-io/milvus-sdk-node/issues). 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](https://github.com/milvus-io/milvus-sdk-node/issues). 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.

0 comments on commit e3040a0

Please sign in to comment.