Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (21 loc) · 727 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 727 Bytes
Raw

Contributing

Thank you for improving TiCity. Start with AGENTS.md, especially the accuracy boundary between an educational model and observed TiDB behavior.

Development

npm install
npm run dev

Before opening a pull request:

npm test
npm run typecheck
npm run build
npm run test:e2e

For architecture corrections, link to primary TiDB documentation or source and explain which model invariant changes. For visible work, include before/after screenshots in both day and night themes. Keep Japanese and English catalog keys in sync and preserve Apache-2.0 attribution.

Do not submit telemetry, live-cluster credentials, SQL execution, copied brand assets, or generated result data.