pingcap / pingcap/docs

🎉 Supported TiDB with APIJSON(Auto supply APIs and Documents), and supplied a demo with Java and a quick start guide with pictures.

Open
#3,530 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

lifecycle/frozen
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the linked APIJSON quick start, APIJSON introduction, and DemoSQLConfig.java configuration example first. Clarify which TiDB documentation or demo should be added, then ensure the requested Java example and illustrated quick-start guidance are available in this repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.