- Create a new branch with the feature youre implementing with the name convention type/BranchName [ej : feat/Home , fix/UserLogin]
- Push your changes to the new branch with one of the following prefix:
feat
: indicates the addition of a new feature or functionality to the project.fix
: used when fixing a bug or error in the code.docs
: changes to the documentationstyle
: formatting, missing semi colons, etc; no production code changerefactor
: refactoring production code, eg. renaming a variabletest
: adding missing tests, refactoring tests; no production code changechore
: updating grunt tasks etc; no production code changeci
: updating scripts for continuous integrationbuild
: update building scripts or Docker Imagesperf
: update code for performance improvementrevert
: revert changesdocs
: Used when making changes or improvements to the project's documentation.
- Add tests for every change you made.
- Go to your branch in Git and then select Pull Request and field the fields indicated in the template.
- Check if Github Actions CI tests are passing, any pull request with errors on CI would not be merged to the master branch.
- The owner of the project will check the Pull Request and then merge it with the main branch.
- The new branch name must be the feature that is going to be implemented.
- Fill the fields of the pull_request_template.
- There are recommended extensions for VS Code inside both backend and frontend. Refer to their respective documentation for installation.
- Node >= 20.12.2
- Python >= 3.11
- Git