Merge pull request #88 from Discusser/chore/update-contributing

Update CONTRIBUTING.md and README.md

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## How to Contribute
+## 🫂 How to Contribute
 
 1. Clone the project
 
@@ -12,14 +12,14 @@ git clone https://github.com/s1lvax/route
 pnpm i
 ```
 
-3. Run a Postgres instance (I recommend using Docker)
+3. Run a Postgres instance (I recommend using Docker CLI on Linux/Mac or Docker Desktop on Windows)
 
 ```bash
 docker run --name your_postgres_container -e POSTGRES_USER=your_username -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=your_database -p 5432:5432 -d postgres
 ```
 
 4. Update the `example.env` to `.env` and fill in your data
-5. Push the databse schema using Prisma
+5. Push the database schema using Prisma
 
 ```bash
 npx prisma db push
@@ -32,4 +32,6 @@ pnpm dev
 ```
 
 7. Develop the change using a separate branch, either `bugfix/name` or `feature/name`
-8. Push your changes and open a Pull Request with details about your changes
+8. Push your changes and open a Pull Request with details about your changes. Pull requests must be made to the `dev` branch
+
+A deployment of the `dev` branch exists at [https://testing.route2.dev/](https://testing.route2.dev/). The `dev` branch is merged into `main` for each new release, and the latest release is deployed at [https://route2.dev/](https://route2.dev/)

README.md

@@ -53,6 +53,8 @@ pnpm dev
 ```
 
 7. Develop the change using a separate branch, either `bugfix/name` or `feature/name`
-8. Push your changes and open a Pull Request with details about your changes
+8. Push your changes and open a Pull Request with details about your changes. Pull requests must be made to the `dev` branch
+
+A deployment of the `dev` branch exists at [https://testing.route2.dev/](https://testing.route2.dev/). The `dev` branch is merged into `main` for each new release, and the latest release is deployed at [https://route2.dev/](https://route2.dev/)
 
 #### All Pull Requests are very appreciated :D