TiDB Development Guide

All Contributors

About this guide

  • The target audience of this guide is TiDB contributors, both new and experienced.

  • The objective of this guide is to help contributors become an expert of TiDB, who is familiar with its design and implementation and thus is able to use it fluently in the real world as well as develop TiDB itself deeply.

The structure of this guide

At present, the guide is composed of the following parts:

  1. Get started: Setting up the development environment, build and connect to the tidb-server, the subsections are based on an imagined newbie user journey.

  2. Contribute to TiDB helps you quickly get involved in the TiDB community, which illustrates what contributions you can make and how to quickly make one.

  3. Understand TiDB: helps you to be familiar with basic distributed database concepts, build a knowledge base in your mind, including but not limited to SQL language, key components, algorithms in a distributed database. The audiences who are already familiar with these concepts can skip this section.

  4. Project Management: helps you to participate in team working, lead feature development, manage projects in the TiDB community.

Contribute to this guide

See CONTRIBUTING.md for details.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!