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 |
|---|---|
| Person 1 | @username |
| Person 2 | @username |
| Person 3 | @username |
| Person 4 | @username |
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:
- Action 1
- Action 2.
- Action 3.
- Action 4.
- Action 5.
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:
- Action 1
- Action 2.
- Action 3.
- Action 4.
- Action 5.
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:
- Idea 1
- Idea 2.
- Idea 3.
- Idea 4.
- Idea 5.
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).
- Step 1
- Step 2.
- Step 3.
- Step 4.
- Step 5.
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.
- Strategy 1
- Strategy 2.
- Strategy 3.
- Strategy 4.
- Strategy 5.
All team members agree to the following conventions around course deadlines:
- Convention 1
- Convention 2
- Convention 3
...etc...
*N.B.
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 [Name of chosen Git Workflow] 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...):
- Workflow 1
- Workflow 2
- Workflow 3
- Workflow 4
- Workflow 5
** This section should be completed AFTER Milestone 4 is done and submitted! Only one is needed PER group. **
In this section we will ask you to self-report the workload distribution to various categories of tasks. For each of the categories, we want you to report the approximate workload distribution, split by the milestone.
Here are the tables you are expected to complete (the first one is pre-filled in so you can see what we're expecting):
| Category | Team member 1 | Team member 2 | Team member 3 | Team member 4 |
|---|---|---|---|---|
| Repository Setup | 60% | 40% | - | - |
| Sketch | 20% | 25% | 25% | 30% |
| Documentation | 10% | 10% | 40% | 40% |
| Project Management | 50% | 50% | 0% | 0% |
| Troubleshooting | - | - | - | - |
Brief notes/explanations (optional):
- No troubleshooting was needed for Milestone 1
- Member 1 and Member did most of the repository setup, whereas 3 and 4 did most of the documentation
| Category | Team member 1 | Team member 2 | Team member 3 | Team member 4 |
|---|---|---|---|---|
| Documentation/Reflection | ||||
| Writing new code | ||||
| Code Reviews/editing | ||||
| Project Management | ||||
| Testing & Troubleshooting |
Brief notes/explanations (optional):
| Category | Team member 1 | Team member 2 | Team member 3 | Team member 4 |
|---|---|---|---|---|
| Documentation/Reflection | ||||
| Writing new code | ||||
| Code Reviews/editing | ||||
| Project Management | ||||
| Testing & Troubleshooting |
Brief notes/explanations (optional):
| Category | Team member 1 | Team member 2 | Team member 3 | Team member 4 |
|---|---|---|---|---|
| Documentation/Reflection | ||||
| Writing new code | ||||
| Code Reviews/editing | ||||
| Project Management | ||||
| Testing & Troubleshooting |
Brief notes/explanations (optional):