supabase__supabase/.github/pull_request_template.md at master

mirror of https://github.com/supabase/supabase.git synced 2026-09-22 13:37:53 +08:00

Files

T

Miranda Limonczenko 84e46779af chore(github) Revise pull request template, include docs skills (#50591 )

Related to DOCS-1289

<img width="2150" height="1540" alt="CleanShot 2026-09-18 at 10 56 14
AM@2x"
src="https://github.com/user-attachments/assets/2a5d69e0-9037-4263-88c7-a624a167e775"
/>


## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Github chore

## What is the current behavior?

The template has not been revised in two years. It is serviceable but
simple. With some minor improvements, we can save time in the review
process and nudge contributors toward better PR descriptions.

## What is the new behavior?

This PR changes the pull request template:
- Adds `write-the-docs` and `edit-the-docs` skill, which was the main
ask for the Linear issue to socialize our skills so that we can retire
the linter
- Add "Problem" and "Solution" rather than "What is the current
behavior" and "What is the new behavior...". They mean approximately the
same thing but I think it's easier to understand and reason about.
- Makes "Additional context" an optional field by commenting it out and
stating "Optional". I find Additional context an annoying dumping ground
for AI slop.
- Adds a new section for writing manual instructions. Very valuable to
speed up the review process.
- Add an optional section for crafting a preview link table.

## Manual testing

1. Open the new template in a markdown visualizer
2. View content. See it is formatted well, links work, and content makes
sense.
3. Uncomment the optional sections. See table is formatted correctly
with the correct link formula.



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Documentation

- Reworked the pull request template into a structured format covering
the problem, solution, review instructions, and checklist.
- Added optional sections for preview links and additional context.
- Updated preview-link guidance with clearer instructions and example
URLs.
- Replaced question-based prompts and manual contribution-guideline
confirmation with a clearer, checkbox-based review workflow.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2026-09-21 09:42:23 -07:00

3.1 KiB

Raw Permalink Blame History

Problem

Describe what went wrong or what need emerged to justify this bug fix, feature, or change. Link any relevant issues here.

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.

Review instructions

Provide a clear numbered procedure that the PR reviewer can walk through.

For example, Open the live and preview links side-by-side.
For example, See the issue is fixed.

Checklist

Check all before review:

I have read 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 and the docs CONTRIBUTING guide

3.1 KiB Raw Permalink Blame History

Problem

Solution

Review instructions

Checklist

3.1 KiB

Raw Permalink Blame History