docs(contributing) add a guide on adding js packages (#2629)

* docs(contributing) add a guide on adding js packages * Update CONTRIBUTING.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Trajan0x <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
synapsecns · May 13, 2024 · 33c3833 · 33c3833
1 parent 1550dc5
commit 33c3833
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/.github/workflows/lerna.yaml b/.github/workflows/lerna.yaml
@@ -4,6 +4,7 @@ on:
     types: [closed]
     paths:
       - 'packages/**'
+      - 'docs/**'
     branches:
       - master
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,10 @@ 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:
+
 ## 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.

diff --git a/docs/bridge/README.md b/docs/bridge/README.md
@@ -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