Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Add some extra documentation from what we've learned from onboarding new team members.
  • Loading branch information
doug-wade committed Aug 4, 2023
1 parent d931605 commit 9587f7d
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Contributing

Thanks for helping out!
# ContributingThanks for helping out!

## Getting started

Expand All @@ -14,6 +12,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 +110,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

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.

0 comments on commit 9587f7d

Please sign in to comment.