docs: update contributors guide

[kangmingtay]

What kind of change does this PR introduce?

• Improve the gotrue documentation

[kangmingtay]

@HarryET & @riderx i've started a PR for improving the documentation for contributors. Since you guys have been helping out so much recently, i thought it would be good to get your opinions on what can be improved / what's lacking in the docs currently :)

[dthyresson]

Thanks @kangmingtay I had some mods, too which I can add to this branch or suggest here:

1. In The Setup section

To install soda: 

go install github.com/gobuffalo/pop/soda@latest

...
> Important. If you happen to already have a local running instance of Postgres running on the port `5432`, perhaps if you have installed via [homebrew on OSX](https://formulae.brew.sh/formula/postgresql) then be certain to stop the process using:
>
> - `brew services stop postgresql`
>
> If you need to run the test environment on another port, you will need to modify several configuration files to use the custom port. See below [Customize Test Environment Postgres Port](#Customize_Test_Environment_Postgres_Port])

Few tips in:

## Running database migrations for supabase

- Create a `.env` file to store the custom gotrue environment variables. You can refer to an example of the `.env` file [here](hack/test.env)
- Start PostgreSQL inside a docker container running `hack/postgresd.sh`
- In your Docker dashboard, you should see `gotrue_postgresql` running on port 5432
- Build the gotrue binary `make build`
- Execute the binary `./gotrue`
  - gotrue runs any database migrations from `/migrations` on start

and then the section about if one has Postgres already running:

### Customize Test Environment Postgres Port

If you want to run your test environment Postgres on a port other than the standard 5432, you will need to update the following configuration and settings files:

///file: postgresd.sh
docker run --name gotrue_postgresql
-p 7432:5432 \ 👈 set the first value to your external facing port

The port you customize here can them be used in the subsequent configuration:

// file: database.yaml
test:
dialect: "postgres"
database: "postgres"
host: {{ envOr "POSTGRES_HOST" "127.0.0.1" }}
port: {{ envOr "POSTGRES_PORT" "7432" }} 👈 set to your port

// file: test.env
DATABASE_URL="postgres://supabase_auth_admin:root@localhost:7432/postgres" 👈 set to your port

//file: migrate.sh
export GOTRUE_DB_DATABASE_URL="postgres://supabase_auth_admin:root@localhost:5432/$DB_ENV"

Also, there are a few install and helpful commands you shared with me during installation:

brew install go@1.16 install Go

That make build will build 2 binaries:

$ make build                                                                                
go build -ldflags "-X github.com/supabase/gotrue/cmd.Version=`git rev-parse HEAD`"
GOOS=linux GOARCH=arm64 go build -ldflags "-X github.com/supabase/gotrue/cmd.Version=`git rev-parse HEAD`" -o gotrue-arm64

We set real GOTRUE_SMTP_HOST settings.

If people do not have access to that, what do they use?

docker exec -it gotrue_postgresql bash gets you into bash on the PostgreSQL container

docker container rm -f gotrue_postgresql removes
docker volume rm postgres_data removes volume

[dthyresson]

I added some notes that I had been keeping in my Contribute and Readme that helped my install.

Le me know if you want me to work them into your PR and happy to.

[HarryET]

A point on that @dthyresson, Make sure not to suggest brew as an install method as it doesn't work on M1 MacBooks/Macs and that would fix #280

[chimon2000]

@kangmingtay Should this PR include the guidelines for splitting work into PRs by feature or by individual bug fixes?

Mentioned here: #269 (comment)

[riderx]

Thanks @kangmingtay for the improvement, i will try to play the install again to report better issue around install process

[riderx]

./hack/postgresd.sh didn't work when we tried there error in the script from dbname I think @HarryET you remember ?

[kangmingtay]

hey @riderx, sorry for the late reply, thanks for pointing this out, are you able to recall the error message you encountered? 🤔

[riderx]

Same in migration we need to check the script work from 0

[kangmingtay]

could you elaborate by what you mean by "work from 0" ?

[awalias]

a huge improvement, thanks both!

[dthyresson]

Approved.

[github-actions]

🎉 This PR is included in version 2.2.14 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀