TBD
- 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
- Jest: Orta.vscode-jest
Should follow this structure
If your component takes in any props define an interface for them at the top most level underneath the imports
Test structure should be a mirror of the src file and follow the naming convention sameNameAsFileBeingTested.test.tsx
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
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
TypeScript - Note: If you are familiar with javascript then you can just learn this as you develop