-
Notifications
You must be signed in to change notification settings - Fork 0
Developer WorkFlow
Use this developer workflow for any assigned issued.
During the sprint planning process, developers will be assigned open issues from the development backlog. The issues could be bugs, new features, or improvements on the existing code. For each sprint, read through your assigned issues, to get an idea of the code changes that need to be implemented. Choose one of your issues to work on, and follow the steps below to integrate your changes into the master branch. Note that each issue has a unique id in the form of ABC-1234. This id is used as the name of the feature branch you will work on. After developing the feature, the branch will be merged and incorporated into the master branch. Your home directory on the remote server contains a local clone of the central repository. Using this guide you will make changes to the local clone, and push your changes to the central repo. Those change are then reviewed prior to being merged with the master.
This guide assumes you are working on issue ABC-1234
- Step 1: Log into the remote server using WinSCP, you will need the host name, port number, and your server username and password. (These will be provided to you)
- Step 2: Launch Putty session (press ctrl + p). PuTTY brings up a terminal window that you will use to issue commands and interact with the remote server.
- Step 3: Enter your password in terminal that pops up (same password you used for WinSCP)
- Step 4: Type 'cd' to change to you home directory. Note: execute commands by pressing enter.
- Step 5: Type 'cd CAH' to enter the CAH directory
- Step 6: Type 'git pull origin master' to pull latest code into your CAH directory. This ensures you are developing off the latest version of the code.
- Step 7: Type 'git checkout -b ABC-1234' to switch to the ABC-1234 development branch. This will create the branch local to your home git repository if the branch does not already exist.
- Step 8: Use step 8 to edit files necessary to implement and close the issue. Working files can be downloaded off the server using WinSCP. This allows you to edit the file in a Windows environment. After making edits to the files you can upload the updated files onto the server.
- Step 9: Type 'git add .' to stage the updated files for github. This lets version control know which files are ready for the central repo.
- Step 10: Type 'git commit -m "ABC-1234"' to commit changes to branch. This bundles all the changes for version control.
- Step 11: Type 'git push -u origin ABC-1234' to push changes to github. This pushes the changes to the feature branch on the central repo.
Step 11 will generate a pull request. Pull requests will notify the repo owner that changes are ready to be reviewed on the central ABC-1234 branch. The repo owner will then review the code changes, and either accept the changes or request rework from the developer.
If rework is required the developer may need to repeat steps 8-11, otherwise the repo owner will merge the development branch into the master branch, and close the issue.
Once the issue is closed, the developer can delete their local development branch. To do this follow steps 12-14.
- Step 12: Type 'git checkout master' to switch back to the master branch
- Step 13: Type "git pull origin master" to pull in the latest code from the repository
- Step 14: Type "git branch -D ABC-1234" to delete the development branch