Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Weekly keywords check: mismatches found

Open Beginner friendly
  • Is something wrong?
#23,846 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python, sql
Domain
databases, documentation

Research direction

Start with keywords.md and read scripts/check-keywords.py to understand how the check compares documentation with the TiDB parser. Add documentation for ALERT, AUTO, FAST, IMMEDIATE, MATERIALIZED, OPERATE, and TRANSITIONS on the master branch, then rerun the keyword check to confirm it passes.

Written by the indexing model from the issue text.

Description

Weekly Keywords Check Report

Summary

  • master — Keywords check result: ❌ mismatch
  • release-8.5 — Keywords check result: ✅ pass

master — 7 issue(s)

Comparing keywords.md
against TiDB parser (master):

Missing docs for non-reserved keyword from UnReservedKeyword: ALERT
Missing docs for non-reserved keyword from UnReservedKeyword: AUTO
Missing docs for non-reserved keyword from UnReservedKeyword: FAST
Missing docs for non-reserved keyword from UnReservedKeyword: IMMEDIATE
Missing docs for non-reserved keyword from UnReservedKeyword: MATERIALIZED
Missing docs for non-reserved keyword from UnReservedKeyword: OPERATE
Missing docs for non-reserved keyword from UnReservedKeyword: TRANSITIONS

How to fix

Update keywords.md on the affected branch to match the current TiDB parser keywords.
See check-keywords.py for details.

Run date: 2026-09-14 01:20 UTC
Workflow run: https://github.com/pingcap/docs/actions/runs/34795580344

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 6h
Merged PRs (30d)
366

Getting set up

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.

More from pingcap/docs

All issues in pingcap/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.