Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Latest commit

 

History

History
77 lines (49 loc) · 4.04 KB

Contributing.md

File metadata and controls

77 lines (49 loc) · 4.04 KB
Raw

How can you contribute?

Contributing code

If you encounter a bug, you can

  • (Recommended) File an issue about the bug.
  • Provide clear and concrete ways/scripts to reproduce the bug.
  • Provide possible solutions for the bug.
  • Pull a request to fix the bug.

If you're interested in existing issues, you can

  • (Recommended) Provide answers for issue labeled question.
  • Provide help for issues labeled bug, improvement, and enhancement by
    • (Recommended) Ask questions, reproduce the issue, or provide solutions.
    • Pull a request to fix the issue.

If you require a new feature or major enhancement, you can

  • (Recommended) File an issue about the feature/enhancement with reasons.
  • Provide an MEP for the feature/enhancement.
  • Pull a request to implement the MEP.

If you want to become a contributor of Milvus-migration, submit your pull requests! For those just getting started, see GitHub workflow below. All submissions will be reviewed as quickly as possible. There will be a reviewer to review the codes, and an approver to review everything aside the codes. If everything is perfect, the reviewer will label /lgtm, and the approver will label /approve. Once the 2 labels are on your PR, and all actions pass, your PR will be merged into base branch automatically by our @sre-ci-robot

GitHub workflow

Generally, we follow the "fork-and-pull" Git workflow.

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine with git clone [email protected]:<yourname>/milvus-migration.git.
  3. Create a branch with git checkout -b my-topic-branch.
  4. Commit changes to your own branch, then push to GitHub with git push origin my-topic-branch.
  5. Submit a pull request so that we can review your changes.

Remember to sync your forked repository before submitting proposed changes upstream. If you have an existing local repository, please update it before you start, to minimize the chance of merge conflicts.

git remote add upstream [email protected]:zilliztech/milvus-migration.git
git fetch upstream
git checkout upstream/master -b my-topic-branch

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 <[email protected]>

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

Keeping a consistent style for code, code comments, commit messages, and PR descriptions will greatly accelerate your PR review process. We highly recommend you refer to and comply to the following style guides when you put together your pull requests:

Golang coding style

Commits and PRs