Contribution Workflow for Engineers

COLLABOCATE'S COLLABO COMMUNITY ENGINEERING CONTRIBUTION WORKFLOW


Git workflow: Fork and Clone repository

Step 1: Head over to the the repository URL i.e. the GitHub repository for that project.

Step 2: Fork the repository. Then clone the forked repository unto your local computer. Clone URL options explained below:

  • HTTPS url option: If you are using https clone url, the clone command with your url will look like this:

git clone https://github.com/your-github-user-name-here-instead/the-repo-name.git
  • SSH url option: See GitHub documentation for SSH configuration incase you wish to be able to work with SSH url for git operations (that is, if you have not set it up before). If you are using SSH clone url, the clone command with your url will look like this:

git clone [email protected]:your-github-user-name-here-instead/the-repo-name.git
Position of the Green Code button and the popup to copy clone URL on GitHub

Installing dependencies and running the project locally


Git workflow: Create new branch to make your changes in

Except you are requested to create your branch from another branch, always create your new branch from the develop branch:

git checkout develop

Create your branch using the our branch naming convention:

git checkout -b @GH-replaceThisPartWithYourGitHubIssueTicketNumber

For example, if your issue ticket number is 62 on GitHub, you would create the branch like so:

git checkout -b @GH-62

Git workflow: Add, commit and push changes to remote

Make the desired changes you wish to submit to the project, add, commit and push your changes:

git add .
git commit -m "replace this part with a commit message that describes your changes"
git push origin replace-this-part-with-the-name-of-your-branch

Then send a pull request. See page below for the guidelines for submitting pull requests to any repository:

Pull Request Guidelines

Last updated

Was this helpful?