Project Bootstrap¶
Team & Repository Setup¶
Objective 🎯¶
The goal of this first task is to get your team organized and set up the professional collaboration environment we will use for the entire semester: GitHub. This exercise will ensure that every team member has a working GitHub account and understands the basic workflow of making a contribution to a shared project. We will use a course template that includes pre-configured settings for our development environment.
Due Date & Grading¶
- Due: See Canvas.
- Grading: This is a Complete / Incomplete task that's an integral part of your project. To receive a "Complete" grade for this assignment, every team member must successfully complete their part.
Step-by-Step Instructions¶
Form Your Team¶
Decide on your project team of 3-4 members. Once your team is formed, designate one person to be the "Repo Lead" for the initial setup.
Create the Repository¶
Repo Lead's Task
The Repo Lead will create the shared project space by using a course template.
- Navigate to the Template: Go to the template repository at https://github.com/genaiforbusiness/chatbox.
- Use the Template: Click the green "Use this template" button and select "Create a new repository".
- Configure Your New Repository:
- Owner: Ensure the repository is owned by your personal GitHub account.
- Repository name: Use the format
ai-poc-team-<your-team-name>
(e.g.,ai-poc-team-innovators
). - Visibility: You must select Private. This is a critical step.
- Click "Create repository".
- Add Collaborators: Add Collaborators: In your newly created repository, go to Settings > Collaborators and teams. You must add two types of collaborators:
- Your Teammates: Click "Add people" and add each of your teammates using their GitHub username.
- The Instructor: You must also add the instructor so your work can be viewed and graded. The instructor's GitHub username is
midhubalan
.
Your teammates and the instructor will need to accept the email invitation to gain access. This step is critical for grading.
Clone the Repository¶
Clone the Repository: Everyone's Task
Now, each team member needs to create a local copy of the project on their computer (or in their Codespace).
- Navigate to the main page of the team's new repository (not the template).
- Click the green "<> Code" button.
- Copy the URL provided (use the HTTPS option).
- Open a terminal or command prompt and run the following command:
Create Your Profile Page¶
Create Profile: Everyone's Task
This is your first individual contribution to the project.
- Navigate into the new project folder you just cloned.
- Create a new file. The filename must be your exact GitHub username followed by
.md
. For example, if your username isj-doe
, the file must be namedj-doe.md
. - Open the file and add the following information using Markdown formatting:
- Save the file.
Commit and Push Your Changes.¶
Commit and Push: Everyone's Task
Finally, you will save your new file to the shared repository on GitHub using a three-step command-line process.
- Add the file: Tell Git to track your new file.
- Commit the file: Save a snapshot of your changes with a descriptive message.
- Push the file: Send your saved changes up to the shared GitHub repository.
Submission & Verification¶
- Submission: The Repo Lead will submit a single link to the team's GitHub repository on Canvas.
- Verification: Before submitting, check the following:
- ✅ The repository is private.
- ✅ All team members are listed as collaborators under Settings.
- ✅ Each team member has successfully created and pushed their own unique
<username>.md
file to the repository. - ✅ All team members appear under the "Contributors" tab on the main repository page.