-
Notifications
You must be signed in to change notification settings - Fork 0
Admin
To start working on a ticket, head to the project board under Current Sprint
and pick a ticket from the To Do
section
Open up the ticket and assign yourself.
To start working on a ticket, you need to create a branch. This is where all your changes will be made.
To create a branch, use git checkout -b <UABC-123-your-branch-name>
Where 123
describes the ticket number that you are working on and your-branch-name
is an appropriate name that describes the ticket. Note that the branch name should be lowercase and hyphenated.
Once you have made some changes, you can make your commits to save your changes. You will first need to stage all changes, commit, and then push to remote. You can either do this through the VSCode interface, GitHub Desktop, or with your CLI.
Through VSCode:
Stage all changes
Enter a commit message and commit
Push changes to remote
Through CLI:
Use git add .
to stage all changes, git commit -m "message"
to commit changes, and git push -u origin <branch>
(where <branch>
is the name of your branch) to push changes to remote.
Note that once you set the upstream branch with git push -u origin <branch>
, you can just use git push
with consecutive pushes.
![image](https://private-user-images.githubusercontent.com/119282717/315963854-acbf8020-c7e3-4db4-ac03-f7967d659a9f.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MzQ4OTYsIm5iZiI6MTczOTYzNDU5NiwicGF0aCI6Ii8xMTkyODI3MTcvMzE1OTYzODU0LWFjYmY4MDIwLWM3ZTMtNGRiNC1hYzAzLWY3OTY3ZDY1OWE5Zi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjE1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxNVQxNTQ5NTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT0yZjJiOGVmYTMwYjA2OTU5OThiZDZlMmRhYmYyYjU2NDJkM2IyYjY4YjJmMzVjMTNjOGY2NDI2YTE1NGVmODQ0JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.UxCItiXkMU8KPon8nf6U3WAO3K_CGickrA5y7cnqlsg)
To submit your changes for approval, you have to create a pull request. To do this, open up to Pull Requests tab
![image](https://private-user-images.githubusercontent.com/119282717/315964647-e21efb49-c88e-4d9f-ba1d-2f17610e4313.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MzQ4OTYsIm5iZiI6MTczOTYzNDU5NiwicGF0aCI6Ii8xMTkyODI3MTcvMzE1OTY0NjQ3LWUyMWVmYjQ5LWM4OGUtNGQ5Zi1iYTFkLTJmMTc2MTBlNDMxMy5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjE1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxNVQxNTQ5NTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT0zNzU3ODkyODQ2ODRmYmZjNTBlMjBiMDY1MTA2ZGFlMjQ5YjdhZTkyNGUyNjRjYmZkZTA1MTI0NWI5OTdjMmFhJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.qC16ialkArlij6CYU9FFS9IpcjinrMqRSDbfjTe85ZA)
Select your branch as the compare
branch
![image](https://private-user-images.githubusercontent.com/119282717/315965292-8a857924-156a-4df5-9a74-26320cb5b220.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MzQ4OTYsIm5iZiI6MTczOTYzNDU5NiwicGF0aCI6Ii8xMTkyODI3MTcvMzE1OTY1MjkyLThhODU3OTI0LTE1NmEtNGRmNS05YTc0LTI2MzIwY2I1YjIyMC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjE1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxNVQxNTQ5NTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT05NDc0YTQwODhkYTViM2UwZDc2YTI4NzQwMzE4ZDg1OTU2MjdlOWRlNGFiNGJkMTA3NDRlMjA5Mzk0NjRhMDIyJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.iUykeAywqGlyRZWTmSEepieLvySYKmxUAerfnFnEjZ4)
and in the description, enter closes #112
. Replace the number 112
with your ticket number. This links your ticket to the PR.
![image](https://private-user-images.githubusercontent.com/119282717/315965651-21b37f03-6144-4edf-8501-de81850621ba.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MzQ4OTYsIm5iZiI6MTczOTYzNDU5NiwicGF0aCI6Ii8xMTkyODI3MTcvMzE1OTY1NjUxLTIxYjM3ZjAzLTYxNDQtNGVkZi04NTAxLWRlODE4NTA2MjFiYS5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjE1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxNVQxNTQ5NTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT05YmExMzg3OTMxY2ZlYWFmMzE5M2RmZDQ2NWZjYzJhYjgyOWQ2YjYyMzA2MzEzNzlhNDc2M2YwMDRmODk0OWI5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.MTqO91p2C3I0N6YT1pan3Tfv67l7I1qxcMmiP6boSMM)
You should see in the sidebar that the PR is now linked to the issue
![image](https://private-user-images.githubusercontent.com/119282717/315967066-c5c6737b-908c-4365-ab3c-05bc8a82c6ae.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MzQ4OTYsIm5iZiI6MTczOTYzNDU5NiwicGF0aCI6Ii8xMTkyODI3MTcvMzE1OTY3MDY2LWM1YzY3MzdiLTkwOGMtNDM2NS1hYjNjLTA1YmM4YTgyYzZhZS5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjE1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxNVQxNTQ5NTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1hZGE3MjcxZTFjMjlmNzlhOWVlODVlNDIwMDMzYjg1Mjg1YmQwMDRlNGY4YjFkYzBhZjIzY2FkYTBlYWYzMDI2JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.F0m7fSrIFTtLIsefDI6DVjLVfIjE3I1zluSgWPEPFWA)
Once you have committed all desired changes, get someone else to review your code. This should be someone who has not worked on the branch before so we can identify any coding mistakes.
![image](https://private-user-images.githubusercontent.com/119282717/315968671-a372382e-8e9c-46bf-a8c8-0f1c7167de9c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MzQ4OTYsIm5iZiI6MTczOTYzNDU5NiwicGF0aCI6Ii8xMTkyODI3MTcvMzE1OTY4NjcxLWEzNzIzODJlLThlOWMtNDZiZi1hOGM4LTBmMWM3MTY3ZGU5Yy5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjE1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxNVQxNTQ5NTZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1lNmVjODBhZTczY2JlODc2ZTU1OWE5M2MyMDk5MjAzZmQxNjY4ZTg1MDI3ZDNhMDljY2UyZWU5MjgxM2E4OTY3JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.PsMgERnS9aTHQ-Mq0-P3j79RILfhyOdzU_lRhMvPXFA)
If all status checks pass, congrats! You can now merge your code!