TiDB Development Guide
  • TiDB Development Guide
  • Contributing to TiDB Development Guide
  • .github
    • pull_request_template
  • TiDB Development Guide
    • Summary
    • contribute-to-tidb
      • Cherry-pick a Pull Request
      • TiDB Code Style and Quality Guide
      • Committer Guide
      • Community Guideline
      • Contribute Code
      • Contribute to TiDB
      • Issue Triage
      • Make a Proposal
      • Miscellaneous Topics
      • Release Notes Language Style Guide
      • Report an Issue
      • Review a Pull Request
      • Write Document
    • extending-tidb
      • Add a function
      • Extending TiDB
    • get-started
      • Get the code, build, and run
      • Commit the code and submit a pull request
      • Debug and profile
      • Install Golang
      • Get Started
      • run-and-debug-integration-tests
      • Setup an IDE
      • Write and run unit tests
    • project-management
      • Project Management
      • Release Train Model
      • TiDB Versioning
    • system-tables
      • System tables
      • slow_query
    • understand-tidb
      • 1PC
      • Async Commit
      • Cost-based Optimization
      • DDL - Data Definition Language / Schema change handling
      • DML
      • DQL
      • Execution
      • Implementation of Typical Operators
      • Implementation of Vectorized Execution
      • Introduction of TiDB Architecture
      • Lock Resolver
      • Memory Management Mechanism
      • MVCC Garbage Collection
      • Optimistic Transaction
      • Parallel Execution Framework
      • Parser
      • Pessimistic Transaction
      • Plan Cache
      • Planner
      • Plugin
      • Privilege
      • Rule-based Optimization
      • Session
      • SQL Plan Management
      • Table Statistics
      • The Life cycle of a Statement
      • transaction-on-tikv
      • Transaction
      • system-tables
        • System tables
        • information_schema
          • information_schema
          • slow_query
Powered by GitBook
On this page
  • How to contribute
  • How to add yourself to the contributors list

Was this helpful?

Contributing to TiDB Development Guide

Welcome to contribute to the TiDB Development Guide!

How to contribute

This guide proposes to provide a one-stop wiki to all the development-related issues. Any changes that can enhance the objective are welcome. Otherwise, we may not accept the pull requests.

  1. Pointing out the mistakes is important. Don't hesitate to file an issue to report mistakes, or make suggestions, if you don't have enough time to refine the content.

  2. Improve the guide content, for example:

    • fix typos and adjust some statements to make them clearer

    • modify the contents if it's outdated

    • add new pages if something is missing

    • adjust the contents if the article structure is unreasonable

  3. Reviewing the pull request

Once the pull request receives 2 LGTM from the maintainers, it can be merged.

How to add yourself to the contributors list

At present, we only count content contribution and review contribution, once you have successfully contributed to this guide, you can nominate yourself as a contributor by the following two commands in the related pull request:

  1. for content contributions:

    @all-contributors please add @your_github_id for content

  2. for pull request review contributions:

    @all-contributors please add @your_github_id for review
PreviousTiDB Development GuideNext.github

Last updated 3 years ago

Was this helpful?