Contributions to DeepSearcher are welcome from everyone. We strive to make the contribution process simple and straightforward.
The following are a set of guidelines for contributing to DeepSearcher. Following these guidelines makes contributing to this project easy and transparent. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Content
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, andenhancementby- (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 are a reviewer/approver of DeepSearcher, you can
- Participate in PR review process.
- Instruct newcomers in the community to complete the PR process.
If you want to become a contributor of DeepSearcher, 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
Generally, we follow the "fork-and-pull" Git workflow.
- Fork the repository on GitHub.
- Clone your fork to your local machine with
git clone [email protected]:<yourname>/deep-searcher.git. - Create a branch with
git checkout -b my-topic-branch. - Commit changes to your own branch, then push to GitHub with
git push origin my-topic-branch. - 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/deep-searcher.git
git fetch upstream
git checkout upstream/master -b my-topic-branchBefore submitting your pull requests for review, make sure that your changes are consistent with the coding style.
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'Keeping a consistent style for code, code comments, commit messages, and PR descriptions will greatly accelerate your PR review process. We highly recommend you run code linter and formatter when you put together your pull requests:
To check the coding styles:
make lintTo fix the coding styles:
make format- Commit message and PR description style: refer to good commit messages