From 642b3cd8cf815318f16d055736884dfdd462a252 Mon Sep 17 00:00:00 2001 From: MrDynamo Date: Thu, 11 Apr 2024 11:07:00 -0500 Subject: [PATCH] docs: refactor contribution guide --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0883b905..a9ebd6b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ We highly recommend joining our Discord before beginning your work. There, you c ## Guidelines -We recommend following conventional commit guidelines in relation to commit messages and branch naming. +We require following conventional commit guidelines in relation to commit messages and branch naming. [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) @@ -32,4 +32,4 @@ We highly recommend using VSCode as your IDE. There is a code workspace already 5. Use VSCode and open the `develop.code-workspace` file under File -> Open Workspace from File, or type `code develop.code-workspace` in your terminal. 6. Inside the Nx Console panel of VSCode, you have access to the project targets. Run the build target for both wizarr-backend and wizarr-frontend. Then run the serve target to begin your work. 7. Visit http://127.0.0.1:5173 (Frontend) and http://127.0.0.1:5000 (Backend) to see your changes in realtime. -8. Create a new branch following conventions, commit your work, and open a PR against the 'develop' branch when you are ready for the team to review your contribution. +8. Create a new branch from 'develop' following conventions, commit your work, and open a PR against the 'develop' branch when you are ready for the team to review your contribution.