This is our tech spec doc.
Our project is using node.js (v16.20.1) and yarn (1.22.19)
A changelog should be maintained to document all changes introduced into the codebase and should be updated as part of the final step in each pull request process.
Criteria - Branch types can be one of:
init
for initial setting up.feat
for new features.added
for adding new files.Changed
for changes in existing functionality.Deprecated
for soon-to-be removed features.Removed
for now removed features.Fixed
for any bug fixes.Security
in case of vulnerabilities.e.g.
Format of the branch name is {feat, fix, refactor}/{your_modification}
****
git pull origin master
{feat, fix, refactor}/{your_modification}
CHANGELOG.md
and make a commit, then push the branch onto remote and create pull request[CHANGELOG.md](<http://changelog.md>)
when all code is done, in accordance to Semantic Versioning, and https://keepachangelog.com/en/1.0.0/git checkout master && git pull origin master
and rebase: git checkout <your branch> && git rebase master