From 3f28a08598e1bae73b2cefdbe3b4a5fdc89517d7 Mon Sep 17 00:00:00 2001 From: Terry Sutton Date: Tue, 13 Sep 2022 09:57:07 -0230 Subject: [PATCH 1/5] Update contributing message --- studio/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/studio/README.md b/studio/README.md index 7e44f26cea9..05db045953c 100644 --- a/studio/README.md +++ b/studio/README.md @@ -32,9 +32,9 @@ Project settings are managed outside of the Dashboard. If you use docker-compose - Branch from `master` and name your branches with the following structure - `{type}/{branch_name}` - Type: `chore | fix | feature` - - Branch Name: Arbitrary, just make sure it summarizes the work -- Send a PR to `master` and tag the following members in your PR as reviewers - - [MildTomato](https://github.com/mildtomato), [phamhieu](https://github.com/phamhieu), [joshenlim](https://github.com/joshenlim) + - The branch name is arbitrary—just make sure it summarizes the work. +- When you send a PR to `master`, it will automatically tag members of the frontend team for review. +- Review the [contributing checklists](contributing/contributing-checklists.md) to help you test your feature before you send a PR. ### Developer Quickstart From eacd93c73b11fe7c0ae991d73d70d0d4b868c4a0 Mon Sep 17 00:00:00 2001 From: Terry Sutton Date: Tue, 13 Sep 2022 09:57:18 -0230 Subject: [PATCH 2/5] Add contributing checklist --- .../contributing/contributing-checklists.md | 93 +++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 studio/contributing/contributing-checklists.md diff --git a/studio/contributing/contributing-checklists.md b/studio/contributing/contributing-checklists.md new file mode 100644 index 00000000000..63aae253e4a --- /dev/null +++ b/studio/contributing/contributing-checklists.md @@ -0,0 +1,93 @@ +# Checklist for contrubuting to the Supabase Dashboard + +First, we appreciate the time you've taken to contribute to Supabase! Thank you! + +The following is a set of checklists to help make sure the code we contribute to the Dashboard is well tested. If you've made changes to any specific tools, please take a couple of minutes and go through the relevant checklist. + +These checklists should help remind you of the important things to test after you've made changes to a feature. + +## Tools / by feature + +### Table Editor + +- [ ] Go to **Table editor**: + - [ ] Create a **new table** + - [ ] Set different fields and types: at least one nullable, one with default generated value (like `now()`), at least one date field + - [ ] Insert a few rows into the table + - [ ] Edit the row with the default spreadsheet view + - [ ] Edit the row with the Side Panel editor (the expand button to the left of the ID column for each row) + - [ ] Add a filter + - [ ] Sort the rows + - [ ] Create a new column and then add a new row + +### Authentication / User management + +- [ ] Go to **Authentication** + - [ ] Invite a new user + - [ ] Search the list of users + - [ ] Go to policies and create a new policy for a table + - [ ] Check logs view + - [ ] Go to settings and check that any changes you make get saved + - [ ] General + - [ ] Add redirect URL + - [ ] Enable a couple of Auth providers + +### Storage + +- [ ] Go to **Storage** + - [ ] Go to **Settings** and try to change the upload size limit (unless on Free plan) + - [ ] **Create a new bucket** + - [ ] Go to your new **bucket** (check if it is public or private) + - [ ] Upload a file + - [ ] Create a folder + - [ ] Upload a file to your new folder + - [ ] Download the file + - [ ] Copy URL for your file and open it in new incognito tab (check that it respects private/public setting) + - [ ] Go to **Policies**: add a policy for a bucket + - [ ] Change public/private status for your bucket + - [ ] Check if objects respect private/public setting + +### SQL Editor + +- [ ] Go to **SQL editor** + - [ ] Create **new query** + - [ ] Run a query (ex: `select * from extensions.pg_stat_statements`) and check that it returns results + - [ ] Download a csv of the results (via results dropdown above the preview table) + - [ ] Go to **Welcome** and choose and run a template (ex: "Create table") + - [ ] Switch between queries, rename one of your queries, refresh page, delete one of your queries + +### Edge Functions + +- [ ] Go to **Edge Functions** + - [ ] See that any functions you've created are listed + - [ ] Click a function and see that its **Metrics** are displaying + - [ ] Switch to **Details** - you should see the details of your function + - [ ] Switch to **Invocations** and **Logs** - to see logs of recent activity + +### Logs Explorer + +- [ ] Go to **Logs Explorer** + - [ ] Switch to **Templates** and select one + - [ ] Check that query results are displaying properly + - [ ] Make a change to the query from the template and Save this query + - [ ] Switch to **Saved** - you should see your new query, run it and check the results + - [ ] Switch to **Recent** - you should be able to see recent queries you've run + +### Database settings + +- [ ] Go to **Database** + - [ ] You should see any tables you have created + - [ ] click on a table column, try and edit it + - [ ] Go to **Roles** - check if it is displaying roles + - [ ] Go to **Extensions** - filter the extensions, try enabling and disabling an extension + - [ ] Go to **Replication** — enable, disable few event types for `supabase_realtime` add some tables to replication + - [ ] Go to **API Logs**, **Postgres Logs**, **Realtime Logs** + - [ ] check filtering: time range, product, status, method + +### Org settings + +- [ ] Go to **Organizations** and select your organization + - [ ] On **General** - you should be able to rename your organization + - [ ] On **Team** - you should be able to invite team members + - [ ] On **Billing** - you should be able to see your project details and change billing address and email + - [ ] On **Invoices** - you should be able to download recent invoices From 469c245ffde5368b9837e115c65ec7c1731c410b Mon Sep 17 00:00:00 2001 From: Terry Sutton Date: Tue, 13 Sep 2022 10:06:23 -0230 Subject: [PATCH 3/5] Grammar --- studio/README.md | 2 +- .../contributing/contributing-checklists.md | 26 +++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/studio/README.md b/studio/README.md index 05db045953c..9003d464941 100644 --- a/studio/README.md +++ b/studio/README.md @@ -34,7 +34,7 @@ Project settings are managed outside of the Dashboard. If you use docker-compose - Type: `chore | fix | feature` - The branch name is arbitrary—just make sure it summarizes the work. - When you send a PR to `master`, it will automatically tag members of the frontend team for review. -- Review the [contributing checklists](contributing/contributing-checklists.md) to help you test your feature before you send a PR. +- Review the [contributing checklists](contributing/contributing-checklists.md) to help test your feature before sending a PR. ### Developer Quickstart diff --git a/studio/contributing/contributing-checklists.md b/studio/contributing/contributing-checklists.md index 63aae253e4a..d4a1257d657 100644 --- a/studio/contributing/contributing-checklists.md +++ b/studio/contributing/contributing-checklists.md @@ -1,18 +1,18 @@ -# Checklist for contrubuting to the Supabase Dashboard +# Checklists for contrubuting to the Supabase Dashboard First, we appreciate the time you've taken to contribute to Supabase! Thank you! -The following is a set of checklists to help make sure the code we contribute to the Dashboard is well tested. If you've made changes to any specific tools, please take a couple of minutes and go through the relevant checklist. +The following is a set of checklists to help make sure the code we contribute to the Dashboard is well tested. If you've made changes to any specific tools, please take a couple of minutes and go through the relevant checklist below. -These checklists should help remind you of the important things to test after you've made changes to a feature. +You don't need to go through all of these for every PR you contribute. These checklists should help remind you of the important things to test after you've made changes to a feature. For example, if you make changes to the Table Editor, just run through that checklist below. -## Tools / by feature +## Tools and features ### Table Editor -- [ ] Go to **Table editor**: +- [ ] Go to **Table editor** - [ ] Create a **new table** - - [ ] Set different fields and types: at least one nullable, one with default generated value (like `now()`), at least one date field + - [ ] Add different fields and types: at least one nullable, one with default generated value (like `now()`), at least one date field - [ ] Insert a few rows into the table - [ ] Edit the row with the default spreadsheet view - [ ] Edit the row with the Side Panel editor (the expand button to the left of the ID column for each row) @@ -25,11 +25,11 @@ These checklists should help remind you of the important things to test after yo - [ ] Go to **Authentication** - [ ] Invite a new user - [ ] Search the list of users - - [ ] Go to policies and create a new policy for a table + - [ ] Go to Policies and create a new policy for a table - [ ] Check logs view - [ ] Go to settings and check that any changes you make get saved - [ ] General - - [ ] Add redirect URL + - [ ] Add a redirect URL - [ ] Enable a couple of Auth providers ### Storage @@ -52,7 +52,7 @@ These checklists should help remind you of the important things to test after yo - [ ] Go to **SQL editor** - [ ] Create **new query** - [ ] Run a query (ex: `select * from extensions.pg_stat_statements`) and check that it returns results - - [ ] Download a csv of the results (via results dropdown above the preview table) + - [ ] Download a csv of the results (via the Results dropdown above the preview table) - [ ] Go to **Welcome** and choose and run a template (ex: "Create table") - [ ] Switch between queries, rename one of your queries, refresh page, delete one of your queries @@ -69,7 +69,7 @@ These checklists should help remind you of the important things to test after yo - [ ] Go to **Logs Explorer** - [ ] Switch to **Templates** and select one - [ ] Check that query results are displaying properly - - [ ] Make a change to the query from the template and Save this query + - [ ] Make a change to the query from the template, save this query - [ ] Switch to **Saved** - you should see your new query, run it and check the results - [ ] Switch to **Recent** - you should be able to see recent queries you've run @@ -77,12 +77,12 @@ These checklists should help remind you of the important things to test after yo - [ ] Go to **Database** - [ ] You should see any tables you have created - - [ ] click on a table column, try and edit it - - [ ] Go to **Roles** - check if it is displaying roles + - [ ] Click on a table column, try and edit it + - [ ] Go to **Roles** - check if roles are displayed - [ ] Go to **Extensions** - filter the extensions, try enabling and disabling an extension - [ ] Go to **Replication** — enable, disable few event types for `supabase_realtime` add some tables to replication - [ ] Go to **API Logs**, **Postgres Logs**, **Realtime Logs** - - [ ] check filtering: time range, product, status, method + - [ ] Check filtering: time range, product, status, method ### Org settings From 8a887e6d72fd1f469161a171b16709f13a5eac53 Mon Sep 17 00:00:00 2001 From: Terry Sutton Date: Tue, 13 Sep 2022 12:15:43 -0230 Subject: [PATCH 4/5] Add note about self-hosted differences --- studio/contributing/contributing-checklists.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/studio/contributing/contributing-checklists.md b/studio/contributing/contributing-checklists.md index d4a1257d657..4cc6dac1690 100644 --- a/studio/contributing/contributing-checklists.md +++ b/studio/contributing/contributing-checklists.md @@ -6,6 +6,8 @@ The following is a set of checklists to help make sure the code we contribute to You don't need to go through all of these for every PR you contribute. These checklists should help remind you of the important things to test after you've made changes to a feature. For example, if you make changes to the Table Editor, just run through that checklist below. +**Note**: not all of these tools are available in the self-hosted Dashboard. If your PR is related to Storage, Edge Functions, Logs Explorer or Organization settings, just leave a comment on the PR and a Supabase team member will have a look for you. + ## Tools and features ### Table Editor From 8edce196a358984b776263e4b4d8cab7aae4e386 Mon Sep 17 00:00:00 2001 From: Terry Sutton Date: Thu, 15 Sep 2022 14:01:49 -0230 Subject: [PATCH 5/5] Remove space --- studio/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/studio/README.md b/studio/README.md index 9003d464941..13724b6b4b3 100644 --- a/studio/README.md +++ b/studio/README.md @@ -32,7 +32,7 @@ Project settings are managed outside of the Dashboard. If you use docker-compose - Branch from `master` and name your branches with the following structure - `{type}/{branch_name}` - Type: `chore | fix | feature` - - The branch name is arbitrary—just make sure it summarizes the work. + - The branch name is arbitrary — just make sure it summarizes the work. - When you send a PR to `master`, it will automatically tag members of the frontend team for review. - Review the [contributing checklists](contributing/contributing-checklists.md) to help test your feature before sending a PR.