Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

chore(github) Revise pull request template, include docs skills (#50591)

Miranda Limonczenko84e46779afe6
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?
+## Solution
-Bug fix, feature, docs update, ...
+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.
-## What is the current behavior?
+<!--
+## Preview links
-Please link any relevant issues here.
+If relevant, include links to changed pages for easy review access.
-## What is the new behavior?
+Copy the preview base URL from the Vercel bot comment on this PR. Use the following table as an example template.
-Feel free to include screenshots if it includes visual changes.
+| Site | Live | Preview | Search for |
+| -------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ----------------------------- |
+| WWW | [/blog/your-post](https://supabase.com/blog/your-post) | [/blog/your-post](https://zone-www-dot-com-git-branch-name-supabase.vercel.app/blog/your-post) | unique phrase from the change |
+| Docs | [/docs/guides/your-page](https://supabase.com/docs/guides/your-page) | [/docs/guides/your-page](https://docs-git-branch-name-supabase.vercel.app/docs/guides/your-page) | unique phrase from the change |
+| Studio | [/dashboard](https://supabase.com/dashboard) | [/dashboard](https://studio-git-branch-name-supabase.vercel.app/dashboard) | unique phrase from the change |
+| Design system | [/design-system](https://supabase.com/design-system) | [/design-system](https://design-system-git-branch-name-supabase.vercel.app/design-system) | unique phrase from the change |
+| UI library | [/library](https://supabase.com/library) | [/library](https://ui-library-git-branch-name-supabase.vercel.app/library) | unique phrase from the change |
+| Knowledge base | [/kb/guides/your-page](https://supabase.com/kb/guides/your-page) | [/kb/guides/your-page](https://kb-git-branch-name-supabase.vercel.app/kb/guides/your-page) | unique phrase from the change |
+-->
+
+<!-- ## Additional context
+
+Optionally add any other context or screenshots.
+
+-->
+
+## 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
-## Additional context
+Check all before review:
-Add any other context or screenshots.
+- [ ] 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