mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
1ce1fd6664
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.
YES (in fact, this PR makes a tiny change!)
## What kind of change does this PR introduce?
Docs and config file changes to fix up some outdated docs and improve
the onboarding experience a little bit:
- [x] Fixes up the `pnpm` versioning guidance in `DEVELOPERS.md` (as
well as some small formatting cleanups)
- [x] Introduces a lightweight `mise.toml` file for
[mise](https://mise.en.dev/) users. We use mise in other codebases in
the @supabase org — if you have mise installed and you open your
terminal into this codebase, mise will read the `mise.toml` file and
automatically set up the Node/pnpm versions set in the
`.nvmrc`/`package.json` files.
- [x] Cleans up a TOC in `CONTRIBUTING.md` that looked ill-formatted —
the numbered list appears on one line, which I don't believe is intended
(see
[here](561e43b36c/CONTRIBUTING.md)).
I opted to remove the TOC wholesale as opposed to fixing the formatting
since the GitHub UI has a native TOC viewer.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Updated contributor and developer guides to improve navigation and
clarify setup instructions.
* Removed an extra table of contents from the contributing guide.
* Refined dependency/version guidance and formatting in the development
guide.
* **Chores**
* Updated local tooling settings to better support version-file based
workflows.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2.3 KiB
2.3 KiB
CONTRIBUTING.md
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:
Getting Started
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.
Issues
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.
Pull Requests
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.