Welcome to the TiDB Community! The main objective is to help members of the TiDB community who share similar interests to learn from and collaborate with each other.
Your journey of becoming a contributor and committer starts from here: improving docs, improving code, giving talks, organizing meetups, etc.
You can reach out to the community members via any one of the following ways:
-
Google Groups: https://groups.google.com/forum/#!forum/tidb-user
-
Stack Overflow: https://stackoverflow.com/questions/tagged/tidb
-
Twitter: https://twitter.com/PingCAP
-
Facebook: https://www.facebook.com/pingcap2015
-
Reddit: https://www.reddit.com/r/TiDB
-
Try TiDB! If you like it, star, share, and recommend it.
-
To dig deeper, read a design doc, e.g. architecture, How we build TiDB
-
Start with improving the documentation. You can search open issues to find inspiration for what to work on.
-
There's always code that can be clarified and variables or functions that can be renamed or commented.
-
There's always a need for more test coverage. You can start with an area that has low coverage.
-
Give a talk at a local meetup or conference.
Links in https://pingcap.com/docs lead to many relevant topics, including:
-
TiDB Introduction
-
TiDB Quick Start Guide
-
TiDB Operations Guide
-
TiDB User Guide
-
Frequently Asked Questions（FAQ）
-
TiDB Roadmap
You can start by finding an existing issue with the help-wanted label. These issues are well suited for new contributors.
If a PR (Pull Request) submitted to the TiDB/TiKV/TiSpark/PD/Docs/Docs-cn projects by you is approved and merged, then you become a TiDB Contributor.
Before submitting a pull request, sign the CLA.
If you want to work on a new idea of relatively small scope:
-
Submit an issue describing your proposed change to the repo in question.
-
The repo owners will respond to your issue promptly.
-
If your proposed change is accepted, sign the CLA, and start work in your fork.
-
Submit a pull request containing a tested change.
Once you become a TiDB contributor, check your name here: https://github.com/pingcap/tidb/blob/master/CONTRIBUTORS
Contributions are welcomed and greatly appreciated. See CONTRIBUTING.md for details on submitting patches and the contribution workflow.
First of all you need to get involved and be a Contributor.
Based on your track-record as a contributor, one of our Maintainers or PMC members may invite you to be a committer (after we've called a vote). When that happens, if you accept, the following process kicks into place...
Note that becoming a committer is not just about submitting some patches; it‘s also about helping out on the development and user Discussion Forums, helping with documentation and the issues.
See Become a Committer.md for becoming a committer steps and more details.
Communication within the TiDB community abides by TiDB Code of Conduct. Here is an excerpt:
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
The TiDB Blog is a great resource pool to find content! We post the latest TiDB news including new releases and technical articles there. Check out this page: https://pingcap.com/blog
This weekly newsletter highlights content from the community along with the latest TiDB weekly update & news.
Read the TiDB Weekly archives to catch up on all of the latest TiDB updates and hacks: https://pingcap.com/weekly
Another great resource for finding content! TiDB’s Slideshare account has slide decks from TiDB presentations -- you’re welcome to use and/or modify these slides when presenting to your own meetup group.
If you're interested in writing a tutorial for TiDB, please contact us: community@pingcap.com
TiDB Community is under the Apache 2.0 license. See the LICENSE.md file for details.
Thank you to the Kubernetes, Apache and Docker community pages for providing us with inspiration.