chore: improve dev docs. (supabase#256)

hbela · Sep 20, 2022 · 04bb6eb · 04bb6eb
1 parent 2cda81b
commit 04bb6eb
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -37,8 +37,8 @@ This turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
 
-## Development
+## Development & Contributing
 
-Read the [development.md](./development.md) for more information.
+Read the [development.md](./development.md) guide for more information on local setup, testing, and preparaing a release.
 
 Using a `@supabase/auth-helpers-[framework-name]` naming convention for packages
diff --git a/development.md b/development.md
@@ -15,15 +15,7 @@ Before you begin, make sure you have the following set up on your local machine.
 pnpm install
 ```
 
-### Development setup
-
-You can run all the packages in development mode using the following command:
-
-```bash
-pnpm dev
-```
-
-### Build
+## Build
 
 You can build all packages using the following command:
 
@@ -43,10 +35,30 @@ For react it would be
 pnpm build:react
 ```
 
-### Change logs
+## Local development and testing
+
+Once built, you can run all the packages and examples in development mode using the following command:
+
+```bash
+pnpm dev
+```
+
+After making and building your changes, make sure that the examples continue working and, if needed, update the relevant examples to test changes or added functionality.
+
+## Preparing a release
+
+**NOTE:** Do not touch the version number of any of the packages. These are automatically updated in CI via changeset!
 
-To generate a changelog entry, run the following command:
+---
+
+Once you made your changes, built and tested them, you will need to generate a changelog entry via running:
 
 ```sh
 pnpm changeset
 ```
+
+Step through the steps, select the packages that you've made changes to and indicate what kind of release this is.
+
+Changeset will generate a temporary file (see [example](https://github.com/supabase/auth-helpers/commit/63b1da08ec7b26ff2fe87b4d3c6e0e5f24fc1dc6#diff-bac6aefca6cf9c72965d3202f7d19999562965eb8831fce29cf2e3e0f6bcdc33)). Make sure to commit this file to your PR as this is used in CI to generate the release.
+
+Once your PR is merged, CI will generate a PR (see [example](https://github.com/supabase/auth-helpers/commit/2cda81bda4ba810b9e73baaca238facc51bab2ce)) with the changelog entries, increment the version numbers accordingly, and remove the temporary changeset files. Upon merging this PR, CI will issue the new release to npm. 🥳