diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c0d20008ea8..7cce99d31de 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,19 +1,47 @@ -## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. +## Problem -YES/NO +Describe what went wrong or what need emerged to justify this bug fix, feature, or change. +Link any relevant issues here. -## What kind of change does this PR introduce? - -Bug fix, feature, docs update, ... - -## What is the current behavior? - -Please link any relevant issues here. - -## What is the new behavior? +## Solution +Provide a brief description of the change and the key choices you made when architecting the solution. Feel free to include screenshots if it includes visual changes. -## Additional context + + + + +## Review instructions + +Provide a clear numbered procedure that the PR reviewer can walk through. + +1. For example, `Open the live and preview links side-by-side.` +2. For example, `See the issue is fixed.` + + +## Checklist + +Check all before review: + +- [ ] I have read [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) +- [ ] If I wrote a new docs topic or edited an existing topic, I used the `/write-the-docs` or `/edit-the-docs` skill, which references [WORD_LIST](https://github.com/supabase/supabase/blob/master/apps/docs/WORD_LIST.md) and the docs [CONTRIBUTING](https://github.com/supabase/supabase/blob/master/apps/docs/CONTRIBUTING.md) guide