PingCAP Style Guide

Guide to writing idiomatic code at PingCAP and in the TiKV project.

---

Project maintained by pingcap Hosted on GitHub Pages — Theme by mattgraham

Git and GitHub

• Using Git and GitHub
• Making a good pull request
• Reviewing guidelines

FIXME

• links above are broken (no content yet)
• Notes for things to write about
  • GH workflow (origin/upstream)
  • PingCAP workflow (reviews, rebases, etc.)
  • commit messages and PR messages
  • sign off

Resources

• Pro Git (the Git book)
• GitHub Git docs
• Google code review best practices
• TiKV contribution flow