Skip to content

Update contributing guide #1127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged

Update contributing guide #1127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,17 @@ license your work under the terms of the [Apache 2.0 License](../LICENSE).

## Code guidelines

We use [`uv`](https://docs.astral.sh/uv/) to manage the Python project, and [`just`](https://github.com/casey/just) as a task runner. See their resepctive documentation for details on how to install. To manage the JavaScript package you will also need to install [NodeJS](https://nodejs.org/)
We use [`uv`](https://docs.astral.sh/uv/) to manage the Python project, and
[`just`](https://github.com/casey/just) as a task runner. See their respective
documentation for details on how to install. To manage the JavaScript package
you will also need to install [NodeJS](https://nodejs.org/).

Once you have installed `uv`, `just` and NodeJS, you can install required
JavaScript dependencies with `npm`

```sh
npm install
```

Python code is linted using `ruff`, JavaScript code is linted using `prettier`. Run the linters with

Expand Down