Contributing

We're really excited that you're interested in contributing to Elk! Before submitting your contribution, please read through the following guide.

Local Setup

Clone the repository and run on the root folder:

pnpm i
pnpm run dev

Warning: you will need corepack enabled, check out the Elk Contributing Guide for a detailed guide on how to set up the project locally.

We recommend installing ni, that will use the right package manager in each of your projects. If ni is installed, you can instead run:

ni
nr dev

Testing

Elk uses Vitest. You can run the test suite with:

nr test

Translation status

You can see the detail (missing and outdated keys) by clicking on the corresponding row.
If you want to send a PR, click on Edit link on the corresponding translation file, it will open the translation file in GitHub
Language Translated Missing Outdated TotalActions
English (source)
604 keys as source
Edit