You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,11 @@
2
2
3
3
Thank you for your interest in contributing to the Supabase JavaScript client libraries! This guide will help you get started with contributing to the Supabase JS monorepo.
4
4
5
-
> **📣 Coming from a separate repository?** The `supabase-js` repository has been converted into a monorepo and all other Supabase JS libraries have been absorbed into it. If you previously contributed to `auth-js`, `postgrest-js`, `realtime-js`, `storage-js`, or `functions-js`, please read our **[Migration Guide](docs/MIGRATION.md)** to understand the new structure, workflow changes, and command mappings.
5
+
> **Repository Structure Changed:** This repository has been restructured as a monorepo. **All libraries, including `supabase-js`, are now under `packages/core/`**. If you previously contributed to `supabase-js`, `auth-js`, `postgrest-js`, `realtime-js`, `storage-js`, or `functions-js`, please read our **[Migration Guide](docs/MIGRATION.md)** to understand:
6
+
>
7
+
> - Where your code moved (everything is now in `packages/core/<library-name>/`)
8
+
> - How commands changed (`npm test` → `npx nx test <library-name>`)
9
+
> - New workflow with Nx
6
10
7
11
## 📋 Table of Contents
8
12
@@ -56,7 +60,7 @@ Thank you for your interest in contributing to the Supabase JavaScript client li
1.**Ensure your branch is up to date** with `main`:
193
+
1.**Ensure your branch is up to date** with `master`:
190
194
191
195
```bash
192
-
git checkout main
193
-
git pull upstream main
196
+
git checkout master
197
+
git pull upstream master
194
198
git checkout your-branch
195
-
git rebase main
199
+
git rebase master
196
200
```
197
201
198
202
2.**Run the full test suite**:
@@ -283,7 +287,7 @@ npx nx test <package> --coverage
283
287
We automatically generate TypeScript API documentation that is used by the main [Supabase documentation site](https://supabase.com/docs). The process works as follows:
284
288
285
289
1.**TypeDoc generates JSON specifications** from TypeScript source code
286
-
2.**GitHub Actions publishes** these specs to GitHub Pages on every push to `main`
290
+
2.**GitHub Actions publishes** these specs to GitHub Pages on every push to `master`
287
291
3.**Main Supabase repository** uses these JSON files to generate the official API docs via `make` commands
> **📣 Coming from our old repositories?** The `supabase-js` repository has been converted into a monorepo and all other client libraries have been absorbed into it. If you previously contributed to individual repositories like `auth-js`, `postgrest-js`, `realtime-js`, `storage-js`, or `functions-js`, please see our **[Migration Guide](./docs/MIGRATION.md)** to learn about the new structure and workflows.
0 commit comments