Skip to content

Latest commit

 

History

History
107 lines (73 loc) · 5.3 KB

CONTRIBUTING.md

File metadata and controls

107 lines (73 loc) · 5.3 KB
Raw

Contributing to vsag

First of all, thanks for taking the time to contribute to vsag! It's people like you that help vsag come to fruition. 🎉

The following are a set of guidelines for contributing to vsag. Following these guidelines helps contributing to this project easy and transparent. These are mostly guideline, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

As for everything else in the project, the contributions to vsag are governed by our Code of Conduct.

Contribution Checklist

Before you make any contributions, make sure you follow this list.

What contributions can I make?

Contributions to vsag fall into the following categories.

  1. To report a bug or a problem with documentation, please file an issue providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team.
  2. To propose a new feature, please file a new feature request issue. Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the Contributing code.
  3. To implement a feature or bug-fix for an existing outstanding issue, follow the Contributing code. If you need more context on a particular issue, comment on the issue to let people know.

How can I contribute?

Contributing code

If you have improvements to vsag, send us your pull requests! For those just getting started, see GitHub workflow. Make sure to refer to the related issue in your pull request's comment.

GitHub workflow

Please create a new branch from an up-to-date master on your fork.

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine with git clone git@github.com:<yourname>/vsag.git.
  3. Create a branch with git checkout -b my-topic-branch.
  4. Make your changes, commit, then push to to GitHub with git push --set-upstream origin my-topic-branch.
  5. Visit GitHub and make your pull request.

If you have an existing local repository, please update it before you start, to minimize the chance of merge conflicts.

git remote add upstream git@github.com:alipay/vsag.git
git checkout master
git pull upstream master
git checkout -b my-topic-branch

General guidelines

Before sending your pull requests for review, make sure your changes are consistent with the guidelines and follow the vsag coding style.

  • Include unit tests when you contribute new features, as they help to prove that your code works correctly, and also guard against future breaking changes to lower the maintenance cost.
  • Bug fixes also require unit tests, because the presence of bugs usually indicates insufficient test coverage.
  • Keep API compatibility in mind when you change code in vsag. Reviewers of your pull request will comment on any API compatibility issues.
  • When you contribute a new feature to vsag, the maintenance burden is (by default) transferred to the vsag team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.

Developer Certificate of Origin (DCO)

All contributions to this project must be accompanied by acknowledgment of, and agreement to, the Developer Certificate of Origin. Acknowledgment of and agreement to the Developer Certificate of Origin must be included in the comment section of each contribution and must take the form of Signed-off-by: {{Full Name}} <{{email address}}> (without the {}). Contributions without this acknowledgment will be required to add it before being accepted. If contributors are unable or unwilling to agree to the Developer Certificate of Origin, their contribution will not be included.

Contributors sign-off that they adhere to DCO by adding the following Signed-off-by line to commit messages:

This is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

Git also has a -s command line option to append this automatically to your commit message:

$ git commit -s -m 'This is my commit message'

Coding Style

The coding style used in vsag generally follow Google C++ Style Guide. And we made the following changes based on the guide:

  • 4 spaces for indentation
  • Adopt .cpp file extension instead of .cc extension
  • 100-character line length

Format code

Install clang-format-13, or later

$ sudo apt-get install clang-format

To format the code

$ make fmt

Run tests with code coverage

Before submitting your PR, make sure you have run unit test, and your code coverage rate is >= 90%.

Install lcov

$ sudo apt-get install lcov

Run tests and generate code coverage report

$ make test_cov