-
Notifications
You must be signed in to change notification settings - Fork 0
Conventions
We will be using Git and GitHub for version control. It helps in collaboration by allowing multiple developers to work on the same project simultaneously. Although Tyler and Jacob will be mainly responsible for reviewing and merging the branches, it is best for everyone to understand how it works and the convention we will follow.
-
Create a branch from GitHub and link to the issue instead of creating it from your local machine.
-
Branch names should be in lowercase and follow the format AEYB/#[ticket no.]-[ticket title].
-
For example, AEYB/#15-authentication-endpoint. Ticket numbers are the issue numbers which can be seen on the project board.
We won’t have a strict convention in commit messages, but please keep the changes atomic, and the commit messages must be short (5-10 words), informative, and concise.
- “Fix bug causing crash upon clicking the start button”
- “Implement generic button component”
- “Update code” - no helpful information provided
- “Work in progress” - you didn’t need to commit that
Ideally shouldn’t happen very frequently, but when it happens,
- Read through the issue that you’re reviewing
- Communicate with the owner of the branch (encouraged)
- If still stuck, contact Tyler or Jacob (if Tyler is absent) before making a big decision.