GitHub Guide

[Asmaathabet]

Important Rules on Github Follow 💡

✔️ Issues

• you should write the issues carefully and in details as you can .
• you should add suitable Labels for every issue.
• use descriptive names for issues titles.
• create new branch for every issue by using this way issueNumber-descriptiveBranchName .
• when you finish from issue just close it.

✔️ Commits

• write commit for every important step you do during your working in specific issue.
• you can write bunch of commits by using git commit instruction and then write all your commits as a list .
• you should relate your commit to its issue before pushing it.
• push your commits on the branch you worked on Not on Master as you know.

✔️ Pull Requests

• when you create new pull request you should write descriptive explanation about your work in the box .
• you should add awaiting Review Label and add Team Lead and all team members as Reviewers.
• If any one from Reviewers asked for changes, he should change label to 'request-changes`.

✔️ Merge Pull Requests

• There is a rule that prevent merging your pull requests before 4 approvals so be comfortable with that 😄

✔️ Using Labels

• All needed Labels was already added to the project so feel free to include suitable one with your issue.
• when you create issue , you should add To Do label and then when you start working on it you should transfer label to in progress then when you finished from it just add Done label.

✔️ two projects

• In this Repository there is two projects to arrange issues interactions : Front End & Back End.
• we should add all issues to these projects in to do list then transferring it to other lists.