# TiDB Development Guide

[![All Contributors](https://img.shields.io/badge/all_contributors-39-orange.svg?style=flat-square)](#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.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table data-header-hidden><thead><tr><th align="center" valign="top"></th><th align="center" valign="top"></th><th align="center" valign="top"></th><th align="center" valign="top"></th><th align="center" valign="top"></th></tr></thead><tbody><tr><td align="center" valign="top"><a href="https://github.com/LittleFall"><img src="https://avatars.githubusercontent.com/u/30543181?v=4?s=100" alt="Zhi Qi"><br><sub>Zhi Qi</sub></a><br><a href="#content-LittleFall">🖋</a></td><td align="center" valign="top"><a href="https://tisonkun.github.io/Miracle/"><img src="https://avatars.githubusercontent.com/u/18818196?v=4?s=100" alt="tison"><br><sub>tison</sub></a><br><a href="#content-tisonkun">🖋</a> <a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Atisonkun">👀</a></td><td align="center" valign="top"><a href="http://zz-jason.github.io/"><img src="https://avatars.githubusercontent.com/u/5268763?v=4?s=100" alt="Jian Zhang"><br><sub>Jian Zhang</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Azz-jason">👀</a> <a href="#content-zz-jason">🖋</a></td><td align="center" valign="top"><a href="https://github.com/qiancai"><img src="https://avatars.githubusercontent.com/u/79440533?v=4?s=100" alt="Grace Cai"><br><sub>Grace Cai</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Aqiancai">👀</a></td><td align="center" valign="top"><a href="https://ichn.xyz"><img src="https://avatars.githubusercontent.com/u/29735669?v=4?s=100" alt="虎"><br><sub>虎</sub></a><br><a href="#content-ichn-hu">🖋</a> <a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Aichn-hu">👀</a></td></tr><tr><td align="center" valign="top"><a href="https://github.com/bb7133"><img src="https://avatars.githubusercontent.com/u/1174042?v=4?s=100" alt="bb7133"><br><sub>bb7133</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Abb7133">👀</a></td><td align="center" valign="top"><a href="https://www.linkedin.com/in/gregabramowitzweber"><img src="https://avatars.githubusercontent.com/u/1183?v=4?s=100" alt="Greg Weber"><br><sub>Greg Weber</sub></a><br><a href="#content-gregwebs">🖋</a></td><td align="center" valign="top"><a href="https://github.com/djshow832"><img src="https://avatars.githubusercontent.com/u/29590578?v=4?s=100" alt="djshow832"><br><sub>djshow832</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Adjshow832">👀</a></td><td align="center" valign="top"><a href="http://www.zenlife.tk"><img src="https://avatars.githubusercontent.com/u/1420062?v=4?s=100" alt="tiancaiamao"><br><sub>tiancaiamao</sub></a><br><a href="#content-tiancaiamao">🖋</a></td><td align="center" valign="top"><a href="https://github.com/tomdewan"><img src="https://avatars.githubusercontent.com/u/50153616?v=4?s=100" alt="tomdewan"><br><sub>tomdewan</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Atomdewan">👀</a></td></tr><tr><td align="center" valign="top"><a href="https://github.com/disksing"><img src="https://avatars.githubusercontent.com/u/12077877?v=4?s=100" alt="disksing"><br><sub>disksing</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Adisksing">👀</a></td><td align="center" valign="top"><a href="https://www.hawkingrei.com/blog/"><img src="https://avatars.githubusercontent.com/u/3427324?v=4?s=100" alt="Weizhen Wang"><br><sub>Weizhen Wang</sub></a><br><a href="#content-hawkingrei">🖋</a></td><td align="center" valign="top"><a href="https://github.com/TomShawn"><img src="https://avatars.githubusercontent.com/u/41534398?v=4?s=100" alt="TomShawn"><br><sub>TomShawn</sub></a><br><a href="#content-TomShawn">🖋</a></td><td align="center" valign="top"><a href="https://github.com/mjonss"><img src="https://avatars.githubusercontent.com/u/5520054?v=4?s=100" alt="Mattias Jonsson"><br><sub>Mattias Jonsson</sub></a><br><a href="#content-mjonss">🖋</a></td><td align="center" valign="top"><a href="http://www.tocker.ca/"><img src="https://avatars.githubusercontent.com/u/57982?v=4?s=100" alt="Morgan Tocker"><br><sub>Morgan Tocker</sub></a><br><a href="#content-morgo">🖋</a> <a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Amorgo">👀</a></td></tr><tr><td align="center" valign="top"><a href="http://databaseblog.myname.nl"><img src="https://avatars.githubusercontent.com/u/1272980?v=4?s=100" alt="Daniël van Eeden"><br><sub>Daniël van Eeden</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Adveeden">👀</a> <a href="#content-dveeden">🖋</a></td><td align="center" valign="top"><a href="https://xxchan.github.io"><img src="https://avatars.githubusercontent.com/u/37948597?v=4?s=100" alt="xxchan"><br><sub>xxchan</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Axxchan">👀</a></td><td align="center" valign="top"><a href="https://www.iamhlbx.xyz"><img src="https://avatars.githubusercontent.com/u/50866227?v=4?s=100" alt="iamhlbx"><br><sub>iamhlbx</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3AHuGanghui">👀</a></td><td align="center" valign="top"><a href="https://github.com/sunxiaoguang"><img src="https://avatars.githubusercontent.com/u/3982329?v=4?s=100" alt="Xiaoguang Sun"><br><sub>Xiaoguang Sun</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Asunxiaoguang">👀</a> <a href="#content-sunxiaoguang">🖋</a></td><td align="center" valign="top"><a href="https://github.com/eurekaka"><img src="https://avatars.githubusercontent.com/u/6261973?v=4?s=100" alt="Kenan Yao"><br><sub>Kenan Yao</sub></a><br><a href="#content-eurekaka">🖋</a></td></tr><tr><td align="center" valign="top"><a href="https://about.me/li.su"><img src="https://avatars.githubusercontent.com/u/528332?v=4?s=100" alt="lysu"><br><sub>lysu</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Alysu">👀</a></td><td align="center" valign="top"><a href="https://github.com/cfzjywxk"><img src="https://avatars.githubusercontent.com/u/3692139?v=4?s=100" alt="cfzjywxk"><br><sub>cfzjywxk</sub></a><br><a href="#content-cfzjywxk">🖋</a> <a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Acfzjywxk">👀</a></td><td align="center" valign="top"><a href="https://blog.tongmu.me"><img src="https://avatars.githubusercontent.com/u/9587680?v=4?s=100" alt="you06"><br><sub>you06</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Ayou06">👀</a></td><td align="center" valign="top"><a href="https://github.com/ekexium"><img src="https://avatars.githubusercontent.com/u/31720476?v=4?s=100" alt="Ziqian Qin"><br><sub>Ziqian Qin</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Aekexium">👀</a></td><td align="center" valign="top"><a href="https://github.com/zhangyangyu"><img src="https://avatars.githubusercontent.com/u/3690895?v=4?s=100" alt="Xiang Zhang"><br><sub>Xiang Zhang</sub></a><br><a href="#content-zhangyangyu">🖋</a></td></tr><tr><td align="center" valign="top"><a href="https://github.com/XuHuaiyu"><img src="https://avatars.githubusercontent.com/u/9039012?v=4?s=100" alt="HuaiyuXu"><br><sub>HuaiyuXu</sub></a><br><a href="#content-XuHuaiyu">🖋</a></td><td align="center" valign="top"><a href="https://sticnarf.me"><img src="https://avatars.githubusercontent.com/u/17217495?v=4?s=100" alt="Yilin Chen"><br><sub>Yilin Chen</sub></a><br><a href="#content-sticnarf">🖋</a></td><td align="center" valign="top"><a href="https://github.com/tangenta"><img src="https://avatars.githubusercontent.com/u/24713065?v=4?s=100" alt="tangenta"><br><sub>tangenta</sub></a><br><a href="#content-tangenta">🖋</a></td><td align="center" valign="top"><a href="https://github.com/wshwsh12"><img src="https://avatars.githubusercontent.com/u/14054293?v=4?s=100" alt="Shenghui Wu"><br><sub>Shenghui Wu</sub></a><br><a href="#content-wshwsh12">🖋</a></td><td align="center" valign="top"><a href="https://github.com/winoros"><img src="https://avatars.githubusercontent.com/u/7846227?v=4?s=100" alt="Yiding Cui"><br><sub>Yiding Cui</sub></a><br><a href="#content-winoros">🖋</a></td></tr><tr><td align="center" valign="top"><a href="https://github.com/MyonKeminta"><img src="https://avatars.githubusercontent.com/u/9948422?v=4?s=100" alt="MyonKeminta"><br><sub>MyonKeminta</sub></a><br><a href="#content-MyonKeminta">🖋</a></td><td align="center" valign="top"><a href="https://github.com/mengxin9014"><img src="https://avatars.githubusercontent.com/u/22741979?v=4?s=100" alt="Meng Xin"><br><sub>Meng Xin</sub></a><br><a href="#content-mengxin9014">🖋</a></td><td align="center" valign="top"><a href="https://github.com/Mini256"><img src="https://avatars.githubusercontent.com/u/5086433?v=4?s=100" alt="Mini256"><br><sub>Mini256</sub></a><br><a href="#content-Mini256">🖋</a></td><td align="center" valign="top"><a href="https://github.com/qw4990"><img src="https://avatars.githubusercontent.com/u/7499936?v=4?s=100" alt="Yuanjia Zhang"><br><sub>Yuanjia Zhang</sub></a><br><a href="#content-qw4990">🖋</a></td><td align="center" valign="top"><a href="https://github.com/yahonda"><img src="https://avatars.githubusercontent.com/u/73684?v=4?s=100" alt="Yasuo Honda"><br><sub>Yasuo Honda</sub></a><br><a href="#content-yahonda">🖋</a></td></tr><tr><td align="center" valign="top"><a href="https://github.com/windtalker"><img src="https://avatars.githubusercontent.com/u/1916264?v=4?s=100" alt="xufei"><br><sub>xufei</sub></a><br><a href="#content-windtalker">🖋</a></td><td align="center" valign="top"><a href="https://github.com/zanmato1984"><img src="https://avatars.githubusercontent.com/u/1061004?v=4?s=100" alt="ruoxi"><br><sub>ruoxi</sub></a><br><a href="https://github.com/pingcap/tidb-dev-guide/pulls?q=is%3Apr+reviewed-by%3Azanmato1984">👀</a></td><td align="center" valign="top"><a href="https://www.highpon.com/"><img src="https://avatars.githubusercontent.com/u/54130718?v=4?s=100" alt="s-shiraki"><br><sub>s-shiraki</sub></a><br><a href="#content-highpon">🖋</a></td><td align="center" valign="top"><a href="https://github.com/YukihiroArakawa"><img src="https://avatars.githubusercontent.com/u/54029373?v=4?s=100" alt="YukihiroArakawa"><br><sub>YukihiroArakawa</sub></a><br><a href="#content-YukihiroArakawa">🖋</a></td><td align="center" valign="top"></td></tr></tbody></table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!