Contributing to Onlook

We welcome contributions to Onlook! This guide will help you get started with contributing to the project.

When contributing to this repository, please first discuss the change you wish to make via issues, Discord, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

1. To create a Pull Request (PR), create a fork of the project.

2. Create your changes in your fork and open a PR from that fork.

3. Update the PR description with details of the changes. Link the issue if relevant.

4. Be sure to check the box to "Allow edits from maintainer". This allows maintainers to update your PR if necessary which speeds up the review process. See more here.

5. Request a review of one of the maintainers. Once accepted, they will be able to merge your PR.

Style guide

We try to follow guidelines from Clean Code and the boy scoute rule:

"Leave the code cleaner, not messier, than how you found it".

Building and running

You can build the project from source using instructions here.

Testing

We use Bun for testing.

bun test

Linting

We use ESLint for linting and Prettier for formatting. This runs on every commit.

bun lint
bun format