Below is a teamwork contract template adapted from Carnegie Mellon University. It is divided into several sections, and it is expected that each group will spend some time generating at least 5 points for each section that everyone agrees to.
If you are not able to agree on these points, it is a sign that your group may become dysfunctional, and you should seek advice from me (the course instructor) ASAP to resolve and mediate the discussion.
| Name | GitHub Handle |
|---|---|
| Sara Hall | @SaraAnnHall |
| Mayukha Bheemavarapu | @MayukhaB |
| Neethu Gopalakrishna | @Neethu |
| Xin Tian | @xintian927 |
All team members agree to fully participate in all aspects of the project. To accomplish this goal, below are five concrete actions that we all agree to take:
- We will work together to divide tasks evenly.
- We will all show up to meetings.
- We will do our best to communicate effectively.
- Make an effort to document code so others can edit it later.
- Make sure your code is reusable/efficient, and follows best practices.
All team members agree to communicate openly and transparently during the project. To accomplish this goal, below are five concrete actions that we all agree to take:
- Actively share ideas and discuss in the group chat.
- Make detailed and descriptive commit messages.
- Alert teammates when you make a pull request so we can all talk about it.
- Reach out if you need help and help others when they need it.
- Actively discuss the progress of the project.
All team members agree to meet regularly during the project. To accomplish this goal, below are five concrete ideas that we all agree to regarding scheduling and frequency of meetings:
- Meet every week during lab time (1:30 - 3:30 pm Kelowna time, on Wednesdays)
- Meet on Saturdays over zoom, discuss in chat to find times that work for everyone.
- Set up more impromptu meetings if required.
- In meetings share thoughts openly with eachother.
- In meetings, make sure everyone has their voice heard.
The code of conduct we have chosen is in the Code of Conduct document. All team members agree to following the code of conduct, and below are five concrete escalation steps that we all agree to follow in the event that the code of conduct is violated by any member of the group (Step 1 is the first thing you will do, and Step 5 is the last thing you will do).
- Have a text conversation with teammates in the group chat.
- Have a live face to face conversation with teammates.
- Come up with a new plan moving forward to address the issues.
- Reach out to Amanat if we need help.
- Reach out to Firas
N.B. Please do not hesitate to expand beyond 5 steps if needed.
Despite our best intentions, conflict may invariably arise within teammates. Discuss amongst your team some conflict mitigation strategies (feel free to search online if needed) and come up with 5 strategies all members of the team agree to follow in the event there is a conflict within the group. You may also include things you will NOT do in the event a conflict arises.
- Remember we are all in this together and trying our best.
- Take a break/walk.
- Don't take your frustrations out on fellow teammates.
- Be kind to eachother.
- Use a voting system to make team decisions.
All team members agree to the following conventions around course deadlines:
- Finish the project at least 2 days before the deadline.
- Use the 2 days before the deadline for review and to address any concerns.
- If you know you're struggling to reach a particular deadline, reach out to your teammates so that they can help you.
There are many git workflows possible when working on a team project with many moving parts. I suggest you discuss in your group some possible Git workflows. Here is a brief primer on some common options. I suggest reading them, understanding them, and then selecting one. You can explore and choose any you like, but if you cannot decide, I suggest using the "Feature Branch Workflow".
All team members agree to the [Feature Branch] workflow, and the following conventions (e.g., master branch protection, at least X reviews before a pull request, at least N days before the deadline etc...):
- Only add new features in your own branch.
- Test all of you code before issuing a pull request.
- Issue all pull requests at least 2 days before the deadline.
- At least one team member must review before accepting a pull request.
- Master branch must have no errors at all times (keep it protected, don't merge bad code!)
| Category | Sara | Xin | Mayukha | Neethu |
|---|---|---|---|---|
| Repository Setup | 35% | 10% | 10% | 45% |
| Sketch | 25% | 25% | 25% | 25% |
| Documentation | 30% | 25% | 25% | 20% |
| Project Management | 10% | 40% | 40% | 10% |
| Troubleshooting | - | - | - | - |
Brief notes/explanations (optional):
- No troubleshooting was needed for Milestone 1
- We met and worked together as a team for most of this. All member contributed an equal amount.
| Category | Sara | Xin | Mayukha | Neethu |
|---|---|---|---|---|
| Documentation/Reflection | 25% | 25% | 25% | 25% |
| Writing new code | 25% | 25% | 25% | 25% |
| Code Reviews/editing | 10% | 40% | 40% | 10% |
| Project Management | 40% | 10% | 10% | 40% |
| Testing & Troubleshooting | 25% | 25% | 25% | 25% |
Brief notes/explanations (optional): We all tested, documented, and wrote new code equally, while Sara amd Neethu took more of a leadership review and Xin and Mayukha did more code reviews and editing.
| Category | Sara | Xin | Mayukha | Neethu |
|---|---|---|---|---|
| Documentation/Reflection | 25% | 25% | 25% | 25% |
| Writing new code | 25% | 25% | 25% | 25% |
| Code Reviews/editing | 10% | 40% | 40% | 10% |
| Project Management | 40% | 10% | 10% | 40% |
| Testing & Troubleshooting | 25% | 25% | 25% | 25% |
Brief notes/explanations (optional): We all tested, documented, and wrote new code equally, while Sara amd Neethu took more of a leadership review and Xin and Mayukha did more code reviews and editing. We followed our same workflow as Milestone 2.
| Category | Sara | Xin | Mayukha | Neethu |
|---|---|---|---|---|
| Documentation/Reflection | 25% | 25% | 25% | 25% |
| Writing new code | 25% | 25% | 25% | 25% |
| Code Reviews/editing | 10% | 40% | 40% | 10% |
| Project Management | 40% | 10% | 10% | 40% |
| Testing & Troubleshooting | 25% | 25% | 25% | 25% |
Brief notes/explanations (optional): We all tested, documented, and wrote new code equally, while Sara amd Neethu took more of a leadership review and Xin and Mayukha did more code reviews and editing. We followed our same workflow as Milestones 2 and 3.