---
tags: Notes
---
<img src="https://bankaks.com/wp-content/uploads/2020/03/bankaks_logo_menu.png" width="20%"/>

# Contribution guidelines for GitLab

## 1. Steps for contribution
1. Clone it to your system (git clone)
2. In the terminal run
`git remote add upstream https://github.com/URL`
(This is for taking a fresh update of the code anytime in the future)
3. Create a new branch from the Branch Types below.
4. Make the changes, commit and push them.
5. Getting updated code, just run git pull upstream master.

## 2. Branch Name
1. Dev (All the new features will be developed in this branch).
2. Master (Code ready for deployment)
3. Wip**
## 3. Branch Types
1. IssueID-doc-branch name (Changes to documentation)
2. IssueID-feature-branch name (For adding a new feature)
3. IssueID-bug-branch name (Fixing something if it doesn't work)

## 4. Commit Guidelines
1. Only one commit per Feature/Issue/Bug.
2. Commit message should include issue id.
3. Write your commit message in the imperative: "**Fix bug**" and not "**Fixed bug**" or "**Fixes bug.**" This convention matches up with commit messages generated by commands like git merge and git revert.

### Ideal Branch Name
1145-feature-dev

### Ideal Commit Message

#JR-1145 add print invoice button

**Wip branch can be created if required in future.