TensorBase is a community-driven open source project and we welcome any contributor. Contributions to the TensorBase project are expected to adhere to our Code of Conduct.
This document outlines some conventions about development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted. You can also join us in our Discussions, Discord server, Slack channel or Wechat group for help with any issues.
You should explicitly to make sure you adhere to the community's requirements. Currently, it is open to accept two ways : CLA or DCO(Developer Certificate of Origin).
for CLA: you just do agree the CLA once. Just follow the bot's instruction. Many open source projects are using this way.
for DCO: you sign off your commits every time. This is verbose. But if some contributor really only accept this option, it is still OK. The commit message must contain a Signed-off-by line for DCO. Use option git commit -s to sign off your commits.
TensorBase is written in Rust. Before you start contributing code, you need to set up your Rust development environment.
All set to contribute? You can start by finding an existing issue with the good first issue or help-wanted label. These issues are well suited for new contributors.
To contribute to the TensorBase code base, please follow the workflow as defined in this section.
- Create a topic branch from where you want to base your work. This is usually main.
- Make commits of logical units and add test case if the change fixes a bug or adds new functionality.
- Run tests and make sure all the tests are passed.
- Make sure your commit messages are in the proper format (TBD).
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request.
Thanks for your contributions!
If your pull request (PR) is opened, it will be assigned to reviewers. Those reviewers will do a thorough code review, looking at correctness, bugs, opportunities for improvement, documentation and comments, and style.
To address review comments, you should commit the changes to the same branch of the PR on your fork.
Keeping a consistent style for code, code comments, commit messages, and pull requests is very important for a project like TensorBase. Now TensorBase uses the tool rustfmt to gate the coding style. If you are using IDE like vscode, the style is guanrateened automatically.