Initialization

In this step, you will setup your GitLab project and provide some basic project information.

Step 1. Create a README.md

You should have a markdown file in the root of your source tree named README.md. This will be displayed by default when users browse your project and serves as the main landing page for your project.

You must have at-least the following details included in your README.md.

• Project name
• Project description (1-2 sentence description)
• Team details, including names/contact info
• Link to team contract.

Step 2. Add a team contract

In your Wiki, create a page for your Team Contract and link it to your README.md (see above).

Minimally, your team contract needs to contain:

• Names and contact information of all team members.
• Agreement on how you will meet in-person e.g., how often, and location. You are expected to meet at least twice per week and document it.
• Agreement on how you will communicate e.g., email, Messages, WhatsApp, MS Teams. You need one agreed-up communication channel that everyone will check.
• Agreement on team roles: who is the project lead? Are people taking on specific design responsibilities?
• Agreement on how the team will make decisions. Do you vote? Do you need a majority?

See the templates repository for a sample team contract.

Step 3. Submit your project details

When you are done the steps above, please submit for grading.

Login to Learn, navigate to Submit > Dropbox > Project Proposal, and submit a link to your top-level project page. This is important, since it’s the only way we have of easily locating your repository!

This step must be completed by 6:00 PM on the listed time and date.