diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bfa8aae7e..201199e81 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,24 +48,23 @@ Ask anything in our [Discord server](https://discord.com/invite/NAb6H3UTjK) — ### Set up Checkmate locally? -Frontend: +Frontend & backend: ```bash npm install npm run dev ``` -Backend: -Clone and follow instructions in [checkmate-backend](https://github.com/bluewave-labs/checkmate-backend). By default, the frontend expects the backend on `http://localhost:3001`. Update configs if needed. ### Start contributing code? 1. Pick or open an issue (check `good-first-issue`s first) -2. Ask to be assigned. If there is alrady someone assigned and it's been more than 7 days, you can raise the flag and ask to be assigned as well. -3. Create a branch from `develop`. -4. Write your code. -5. Run and test locally. -6. Open a PR to `develop`. +2. (optional but highly suggested) Read a detailed structure of [Checkmate](https://deepwiki.com/bluewave-labs/Checkmate) if you would like to deep dive into the architecture. +3. Ask to be assigned. If there is alrady someone assigned and it's been more than 7 days, you can raise the flag and ask to be assigned as well. +4. Create a branch from `develop`. +5. Write your code. +6. Run and test locally. +7. Open a PR to `develop`. Start with [good first issues](https://github.com/bluewave-labs/checkmate/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).