Contributing

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

Online

You can use StackBlitz Codeflow to fix bugs or implement features. You'll also see a Codeflow button on pull requests (PRs) to review them without a local setup. Once the Nimbus repo has been cloned in Codeflow, the dev server will start automatically and print the URL to open the App. You should receive a prompt in the bottom-right suggesting to open it in the Editor or in another Tab. To learn more, check out the Codeflow docs.

Open in Codeflow

Local Setup

Clone the repository and run on the root folder:

pnpm i --frozen-lockfile
pnpm run dev

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

Testing

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

pnpm 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 Codeflow: read the following guide
Language Translated Missing Outdated TotalActions
English (source)
599 keys as source
Edit