diff --git a/DEVELOPERS.md b/DEVELOPERS.md index e88f3cb89f0..fbbf62bd16a 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -17,14 +17,13 @@ ## Getting started -Thanks for your interest in [Supabase](https://supabase.com) and for wanting to contribute! Before you begin, read the -[code of conduct](https://github.com/supabase/.github/blob/main/CODE_OF_CONDUCT.md) and check out the -[existing issues](https://github.com/supabase/supabase/issues). -This document describes how to set up your development environment to build and test [Supabase](https://supabase.com). +Thank you for expressing your interest in [Supabase](https://supabase.com) and your willingness to contribute! + +To ensure a positive and inclusive environment, we kindly request you to read our [code of conduct](https://github.com/supabase/.github/blob/main/CODE_OF_CONDUCT.md). Additionally, we encourage you to explore the existing [issues](https://github.com/supabase/supabase/issues) to see how you can make a meaningful impact. This document will guide you through the process of setting up your development environment, enabling you to successfully build and test [Supabase](https://supabase.com). ### Install dependencies -You need to install and configure the following dependencies on your machine to build [Supabase](https://supabase.com): +You will need to install and configure the following dependencies on your machine to build [Supabase](https://supabase.com): - [Git](http://git-scm.com/) - [Node.js v16.x (LTS)](http://nodejs.org) @@ -48,7 +47,7 @@ To contribute code to [Supabase](https://supabase.com), you must fork the [Supab git clone https://github.com//supabase.git ``` -1. Go to the Supabase directory: +2. Go to the Supabase directory: ```sh cd supabase ``` @@ -63,7 +62,7 @@ To contribute code to [Supabase](https://supabase.com), you must fork the [Supab npm install # install dependencies ``` -2. You can then run the apps simultaneously with the following. +2. After that you can run the apps simultaneously with the following. ```sh npm run dev # start all the applications ``` @@ -121,7 +120,7 @@ Now when you run a local development docs server you will see the new docs site. After making your changes, open a pull request (PR). Once you submit your pull request, others from the Supabase team/community will review it with you. -Did you have an issue, like a merge conflict, or don't know how to open a pull request? Check out [GitHub's pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) tutorial on how to resolve merge conflicts and other issues. Once your PR has been merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/supabase/supabase/graphs/contributors). +If you have an issue, like a merge conflict, or don't know how to open a pull request then check out [GitHub's pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) tutorial on how to resolve merge conflicts and other issues. Once your PR has been merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/supabase/supabase/graphs/contributors). --- @@ -135,7 +134,7 @@ Create a new entry in the [`redirects.js`](https://github.com/supabase/supabase/ ## Community channels -Stuck somewhere? Have any questions? Join the [Discord Community Server](https://discord.supabase.com/) or the [Github Discussions](https://github.com/supabase/supabase/discussions). We are here to help! +If you are stuck somewhere or have any questions, Join our [Discord Community Server](https://discord.supabase.com/) or the [Github Discussions](https://github.com/supabase/supabase/discussions). We are here to help! ## Contributors