CSE 403 project: Git Setup

Overview

Finalize your set up on GitHub and provide a top-level README for your Git repo.

Setup

Work with your project team. There’s no other set up this time.

Instructions

1. Create your GitHub repo (50%)

Create a public repository for your project on GitHub, make all team members contributors, and add a link to this repository to your living document.

2. Add a top-level README.md file (50%)

The top-level README should briefly describe the idea and goals of your project and explain the layout of the repository. It should link to your living document (which might be stored in the repository, or might be stored elsewhere).

4. Start experimenting and setting up resources

Next week’s milestone will have you finalize your system’s architecture and design, but start exploring, prototyping, and setting up resources. For example, if your project requires setting up a web or SQL server, get started on this task and add relevant instructions and information to your Git repository.

Review and follow the Git conflict resolution tutorial. When merge conflicts come up later in the quarter, you will be happy that you did.

Complete the tasks and submit the link to your repository on Canvas.

Clarifications

Should one person write and commit the status report to the Git repository, or should we each commit our own part of the report?

This is up to you, but in the past teams have found it easiest to write the report collaboratively. Two popular approaches are a Markdown or LaTeX document (stored in GitHub or some other repository), or a Google Doc.

I’ve never used Markdown before, where do I start?

Read GitHub’s introduction to writing Markdown.