Contributing to Typing Genius SDK

Thank you for your interest in contributing! This SDK is designed to be a global repository for typing content in any language.

🔗 Useful Links

Fork and Clone:

git clone https://github.com/Typing-Genius/typing-genius-sdk.git
cd typing-genius-sdk
npm install # or pnpm install / yarn install / bun install

Validate Content:

npm run validate # or pnpm validate / yarn validate / bun validate

We welcome content contributions for all languages.

Open content/{lang_code}/quotes.json and add your quote:

{
  "text": "Quote text in the target language.",
  "author": "Author Name",
  "source": "Optional Source"
}

Open content/{lang_code}/words/{difficulty}.json and add to the list:

{
  "language": "xx",
  "difficulty": "easy",
  "words": ["word1", "word2"]
}

Create Directory: content/{iso_code}/
Add Metadata: Create _meta.json with language details (name, code, contributors).
Add Content: Create quotes.json and words/*.json files.
Register: Add the language to src/languages.ts.

Quotes: Inspirational or educational, diverse lengths, proper attribution.
Words: Real words, standard spelling. "Easy" (3-4 chars), "Medium" (5-6 chars), "Hard" (7+ chars).
Global: We accept content in any language and script.

Thank you for contributing! 🎉