...

Goal

This page documented the workflow for SCuM project with a demo repository.

Requirements

Developers: A GitHub account

Admin: A GitHub account has the admin right of the target repository

Target repository

https://github.com/changtengfei/demo_github_jenkins_repo

Workflows

Workflow for developers

• Fork the target repository

  • Log into your GitHub account

  • Go to repository: https://github.com/changtengfei/demo_github_jenkins_repo and click the “fork“ button on the right side of repository name

• Create an issue

  • Go to https://crystalfree.atlassian.net/secure/BrowseProjects.jspa and select the project you are working on

  • Click the “+“ on the left bar of the page to create an issue in Jira system

    • Fill the Summary of the issue and the description if necessary

    • Assignee to yourself if you are the one working on the issue

    • Click “Create“ to create an issue

    • In the issue page, change the STATUS to IN PROGRESS

• Resolving the issue

  • Clone the repo just forked on your local computer with following command:

    • git clone https://github.com/[GitHub Account]/demo_github_jenkins_repo

  • By default, you will be on “master“ branch. Create a new branch based on the “master“ branch. Use a name starting with the issue ID, such as, “SW-4”. allows Jira system hook the branch link in the issue page.

    • git branch # make sure you are on master branch

    • git checkout -b [name_of_your_new_branch] # create a new branch

  • You will work on the issue/task and commit your code into the created new branch. Use commit message starting with issue ID, such as “SW-4. fix…“, allows Jira system hook the commit link in the issue page.

• Issue Resolved

  • When you resolve your issue or finish the task, make sure you have commit all your work to the branch and push the changes to GitHub with following command

    • git push origin [name_of_your_new_branch]

  • Go to https://github.com/[GitHub Account]/demo_github_jenkins_repo in a browser

  • Select your branch in the branch drop box on the left side of the page

  • Click “New pull request“ button next to the branch drop box

  • Make sure the target branch is https://github.com/changtengfei/demo_github_jenkins_repo:master

  • Review the changes and click “Create pull request“ when you are satisfied with your changes.

  • Go to the issue page and change the STATUS to RESOLVED

...