From 2c27c1db602a7d6bf7cf46554380013b578f9533 Mon Sep 17 00:00:00 2001 From: Jayant Bhawal Date: Wed, 23 Oct 2024 20:47:45 +0530 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc0fd68f..dca17ff0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing Guidelines +image# Contributing Guidelines Thank you for considering contributing to **Middleware**! We welcome contributions from everyone. @@ -34,11 +34,21 @@ Please follow the existing code style and conventions used in the project. If yo _If you run into issues, please look at the local-setup.sh file. It should be straight-forward enough for you to run it appropriately on your OS. We'll appreciate an issue being created for this, if it didn't work out of the box for you._ -2. Then after adding the changes to staging, commit it normally. You will observe pre-commit hooks running. +2. Run [`./dev.sh`](https://github.com/middlewarehq/middleware/blob/main/local-setup.sh). + + This is the actual dev server. We recommend going over the [README](https://github.com/middlewarehq/middleware#-developer-setup) for some additional details. + Wait for everything to run. + + You'll see a "Status: Container ready! 🚀🚀" along with all statuses shown below for various services also being ready. + At this point you can load up http://localhost:3333 and you're ready to start! + image + + +4. Then after adding the changes to staging, commit it normally. You will observe pre-commit hooks running. *NOTE*: The pre-commit hooks modifies the files and you have to again add the modified changes to staging and then commit -3. You can run the pre-commit without committing anything as +5. You can run the pre-commit without committing anything as ```bash pre-commit run --all-files // or