Skip to content

Commit

Permalink
docs(contributing) add a guide on adding js packages
Browse files Browse the repository at this point in the history
  • Loading branch information
trajan0x committed May 13, 2024
1 parent 1550dc5 commit c133d21
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/lerna.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
types: [closed]
paths:
- 'packages/**'
- 'docs/**'
branches:
- master

Expand Down
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ Contributions should roughly follow the [uber style guide](https://github.com/ub

<!-- todo: more-->

## Adding a new JS/TS Package

If you need to make a new JS/TS package, here are the steps to follow:

- If adding under `packages/*`, no need to do anything further.
- Otherwise, make sure you add the package to:
- `.github/workflows/lerna.yml` under paths. This will make sure that the package is built and tested in CI.
- `workspaces.packages` in packages.json. This will make sure that the package is built and tested locally.
- `lerna.json` under `packages` and `version` fields. This will make sure that the package is versioned correctly.
- If the package is a library that you'd like to publish, simply set the `private` field in `package.json` to `false` and the `publishConfig` access to public.
- If the package is a UI, please see [here](./.github/workflows/ui-preview.md) for instructions on configuring vercel. Make sure to update the paths there as well.

## Linting

Linting for go is used using [golangci-lint](https://golangci-lint.run/) at the latest released version. Please upgrade or install using your package manager. and run `make lint` from your desired module.
Expand Down
2 changes: 1 addition & 1 deletion docs/bridge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati

## Generating API Docs

<!--TODO: needs to be done from ci to ensure regenration is done-->
<!--TODO: needs to be done from ci to ensure regenration is done.-->
`yarn docusaurus gen-api-docs all`:

### Installation
Expand Down

0 comments on commit c133d21

Please sign in to comment.