1- Pull codebase : git clone https://github.com/Smart-Transformation/Doccerts-Backend.git
2- Open terminal / bash and install gitflow : sudo apt-get install git-flow
3- Open terminal in the project directory and init the gitflow workflow then leave everything to default : git flow init
4- Checkout to develop branch : git checkout develop
5- Start working on your feature : git flow feature start feature_branch
6- Continue your work and use Git like you normally would
7- When youβre done with the development work on the feature, the next step is to push your changes in the branch you created using git flow :
git add .
then git commit -m ":emoji: your commit message"
then git push
8- After that, on the github page you select your branch and do a pull request to the develop branch
9- git flow feature start feature_branch
can be replaced by git flow hotfix start hotfix_branch
depending on what your task is (feature, release, hotfix, support)
10- Make sure that your develop branch is always up to date before you create a new feature
NEVER PUSH TO MASTER DIRECTLY
Commit type | Emoji |
---|---|
Initial commit | π :tada: |
Version tag | π :bookmark: |
New feature | β¨ :sparkles: |
Bugfix | π :bug: |
Metadata | π :card_index: |
Documentation | π :books: |
Documenting source code | π‘ :bulb: |
Performance | π :racehorse: |
Cosmetic | π :lipstick: |
Tests | π¨ :rotating_light: |
Adding a test | β
:white_check_mark: |
Make a test pass | βοΈ :heavy_check_mark: |
General update | β‘ :zap: |
Improve format/structure | π¨ :art: |
Refactor code | π¨ :hammer: |
Removing code/files | π₯ :fire: |
Continuous Integration | π :green_heart: |
Security | π :lock: |
Upgrading dependencies | β¬οΈ :arrow_up: |
Downgrading dependencies | β¬οΈ :arrow_down: |
Lint | π :shirt: |
Translation | π½ :alien: |
Text | π :pencil: |
Critical hotfix | π :ambulance: |
Deploying stuff | π :rocket: |
Fixing on MacOS | π :apple: |
Fixing on Linux | π§ :penguin: |
Fixing on Windows | π :checkered_flag: |
Work in progress | π§ :construction: |
Adding CI build system | π· :construction_worker: |
Analytics or tracking code | π :chart_with_upwards_trend: |
Removing a dependency | β :heavy_minus_sign: |
Adding a dependency | β :heavy_plus_sign: |
Docker | π³ :whale: |
Configuration files | π§ :wrench: |
Package.json in JS | π¦ :package: |
Merging branches | π :twisted_rightwards_arrows: |
Bad code / need improv. | π© :hankey: |
Reverting changes | βͺ :rewind: |
Breaking changes | π₯ :boom: |
Code review changes | π :ok_hand: |
Accessibility | βΏ :wheelchair: |
Move/rename repository | π :truck: |
Other | Be creative |