Skip to content
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

Jump to bottom

docs: Update CONTRIBUTING.md #367

Merged
merged 1 commit into from
Aug 4, 2023
Merged

docs: Update CONTRIBUTING.md #367

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
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,20 @@ $ yarn install

This will also link the packages locally, so the work you do in one package is reflected in the others.

Next, compile the project.

```shell
$ yarn run build
```

And you should be ready to go! To verify that everything is working as expected, start the servers and visit the example.

```shell
$ yarn run serve
```

and visit the example at localhost:3000.

## Top-level Scripts

We use `turbo` for our monorepo scripts, which does a lot of caching for us.
Expand Down Expand Up @@ -98,3 +112,15 @@ The website listens on port 8081.

The best place to get help is to come [join the discord](https://discord.gg/FHpfstT7Dw). There is
a "contributors" channel dedicated to helping contributors.

## Common errors
doug-wade marked this conversation as resolved.
Show resolved Hide resolved

We've seen a few errors in the past that you may encounter:

### Error: Cannot find module '/path/to/tybalt/packages/cli/dist/index.js'

This happens when you try to run a command like `serve` or `test` that requires the cli to have been compiled. Run `yarn run build` to compile the project.

### /bin/sh: line 1: npm: command not found

Although we use yarn, one of our dependencies, esbuild, assumes that npm is available at install time on your path. Make sure to add npm to your path or workspace.