Skip to content

Commit

Permalink
docs: 馃摎 refactor portions of contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
MrDynamo committed Apr 11, 2024
1 parent 619a97b commit 07ae431
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ We highly recommend joining our Discord before beginning your work. There, you c
We recommend following conventional commit guidelines in relation to commit messages and branch naming.

[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

[Branch and Commit Conventions](https://dev.to/varbsan/a-simplified-convention-for-naming-branches-and-commits-in-git-il4)

## Contributing to Wizarr
Expand All @@ -30,5 +31,5 @@ We highly recommend using VSCode as your IDE. There is a code workspace already
4. Run the script to setup your local environment: `./scripts/setup-build-environment.sh`
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://localhost:5173 (Frontend) and http://localhost:5000 (Backend) to see your changes in realtime.
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.

0 comments on commit 07ae431

Please sign in to comment.