Contribution Guide

How to create branch and commit

Our goal is to keep the master branch clean, So before you work on some issue create a new branch using this convention Alfred<number of the issue>,

For example, if the issue number is 1, then, your branch name will be Alfred1

Checkout to your new branch, start working and keep you commit atomic, also make sure that you are using the commit message convention, which is #<number of the issue> - <commit message>

Finished your issue? assign the issue to the reviewer, after a successful review, the issue should be assigned to you again, then you have to merge your branch back to master branch by yourself, How?

first, you should assign the MERGE TOKEN issue to yourself and add a comment to the MERGE TOKEN issue containing the issue number, then checkout to the master branch and do git merge --squash this will merge your branch to the master branch, but it will not commit it, so you should commit it now, you should follow the commit message convention again here, then push the commit, and un-assign the MERGE TOKEN issue again.

What if the MERGE TOKEN issue was assigned to another mate? You should wait until it's available, or if it took long then contact your mate to make sure that he is not committing to the master branch.