- Clone the repo to your perfered IDE(VS Code Highly suggested)
- run npm install
- Assuming you are using VS Code -> Install the following extentsions for ideal development:
- Eslint: dbaeumer.vscode-eslint (Extension Id's)
- Prettier: esbenp.prettier-vscode
Note you may need to run this before making a revision
git config pull.rebase true
Learn how to work with other developers and update your existing branch when someone has mereged theirs
We are using MUI for our front end components
Should follow this structure
If your component takes in any props define an interface for them at the top most level underneath the imports
We will be using Git branch work flow
- create a new branch for every new feature that is being implimented
- You must unit test that code if there is functionality
IMPORTANT: Make sure to commit once to a branch and any changes after should be an ammed commit and not a new commit. This will allow the reivewers to see the diff between revisions easier and make reviews more efficient
should not be more than one page if you have to much code in one pull request you will have to split them up into multiple differnt pull request if possible do not overwhelem the reviewers with too much code. Look into Sub branching to optimize your development workflow in order to not be slowed down while waiting on code to be reviewed or use it to have a follow up pull request if your original one was to large
A PR can only be merged when it has approval from atleast two reviewers