Skip to content

منو

Contributing

How to set up the repo, find a first issue and get a pull request merged. Contributions in English are welcome.

Kashi is MIT licensed and maintained in the open on GitHub. You don’t need to read Persian to help: code, tests, accessibility fixes and English docs are all welcome, and issues and pull requests can be written in English.

Good first issues

Issues labeled good first issue are small, well-described tasks with pointers to the files involved. Comment on one to let others know you’re working on it.

Set up

git clone https://github.com/Sepantapouya/Kashi.git
cd Kashi
npm install
npm run build
npm run docs          # docs site with live demos

Node 22.23.4 or newer is required (see engines in package.json).

Before opening a pull request

npm test             # unit tests, English locale check, size budget
npm run figma:test   # only if you touched a component's look

The full checklist, project structure and rules (logical CSS only, tokens only, no hard-coded interface text, accessibility) are in CONTRIBUTING.md.

Translating the docs

Component pages live in apps/docs/src/pages/docs/**/*.mdx and the English pages in apps/docs/src/pages/en/docs/. Translating one component page is a great first contribution: copy the Persian page into en/docs/components/, translate the text, keep the code and demos as they are, and open a pull request.