Thank you for contributing to Supabase! We’re a big, exciting open source project and we’d love to have you contribute! Here’s some resources and guidance to help you get started:
1. Getting Started 2. Issues 3. Pull Requests
To ensure a positive and inclusive environment, please read our code of conduct before contributing. For help setting up the code in this repo, please follow our DEVELOPERS.md file. For the docs site, follow this CONTRIBUTING.md guide.
If you find a bug, please create an Issue and we’ll triage it.
- Please search existing Issues before creating a new one.
- Please include a clear description of the problem along with steps to reproduce it. Exact steps with screenshots and urls really help here.
We actively welcome your Pull Requests! A couple of things to keep in mind before you submit:
- If you’re fixing an Issue, make sure someone else hasn’t already created a PR fixing the same issue. Likewise, make sure to link your PR to the related Issue(s).
- We will always try to accept the first viable PR that resolves the Issue.
- If you're new, we encourage you to take a look at issues tagged with good first issue.
- If you’re submitting a new feature, make sure you have opened a Discussion to discuss the new feature before opening a PR. We’d love to accept your hard work, but unfortunately if a feature hasn’t gone through a proper design process, your PR will be closed.
- Please use the PR message template and provide detailed context for quicker review. PRs without clear problem statements will be closed.
Prior to submitting your PR, please conduct the following pre-flight checks:
- Run
npm run buildlocally to ensure that your code builds successfully without having to wait on us to approve Vercel Preview deploys. - Ensure that the Prettier tests run successfully on your PR.
Running these before you create the PR will help reduce back and forth with the team.