This assignment introduces the tools and workflow used throughout the course, including Git, GitHub, and GitHub Classroom.

There is no programming required. The goal is to ensure that you can accept a GitHub Classroom assignment, work in the correct branch, make a small change, and submit your work using a pull request.

These skills are required for every assignment in this course.

Objective and Expected Learning Outcomes

By completing this assignment, you will be able to:

  1. Accept an assignment through GitHub Classroom.
  2. Navigate a GitHub repository created for you.
  3. Clone a repository to your local machine.
  4. Create and work in a separate development branch.
  5. Modify a file in the repository.
  6. Commit and push changes to GitHub.
  7. Submit work using a pull request.
  8. Verify your submission on GitHub.

Instructions

Follow the steps below carefully and in order.

Step 1: Accept the GitHub Classroom Invitation

  1. Click the GitHub Classroom invitation link provided on the course website.
  2. Log in to your GitHub account when prompted.
  3. Accept the assignment.
  4. GitHub Classroom will create a private repository for you.
  5. Click the link to access your new repository.

This repository is your submission for this assignment.

Step 2: Clone the Repository

  1. From your repository page, click the green Code button.
  2. Copy the repository URL (HTTPS or SSH).
  3. Open a terminal on your local machine.
  4. Clone the repository:
git clone <repository-url>
  1. Change into the repository directory:
cd <repository-name>

Step 3: Create and Switch to the Development Branch

All work for this course must be done on the development branch.

  1. Create and switch to the development branch:
git checkout -b development
  1. Verify that you are on the correct branch:
git branch

The output should show development as the active branch.

Step 4: Complete the Course Survey

  1. Open a web browser.
  2. Navigate to the course survey using the link below: https://forms.office.com/r/1whyHiSe6j
  3. Complete and submit the survey in full.

Step 5: Record Survey Completion in the Repository

  1. In the repository, open the file named SURVEY_COMPLETION.md.
  2. Follow the instructions in that file to indicate that you have completed the survey.
  3. Save the file.

This step ensures you practice making a meaningful change to a repository file.

Step 6: Commit Your Changes

  1. Check the repository status:
git status
  1. Stage your changes:
git add SURVEY_COMPLETION.md
  1. Commit your changes with a clear message:
git commit -m "Record course survey completion"

Step 7: Push Your Development Branch

Push your work to GitHub:

git push -u origin development

Step 8: Submit via Pull Request

  1. Go to your repository on GitHub.
  2. You should see a prompt to create a pull request for the recently pushed branch.
  3. Open a pull request from development into main.
  4. Do not merge the pull request.

Your submission is complete once the pull request is open.

Submission Requirements

To receive credit, you must:

  1. Accept the GitHub Classroom assignment.
  2. Create and work on the development branch.
  3. Complete the course survey.
  4. Update SURVEY_COMPLETION.md.
  5. Commit and push your changes to development.
  6. Open a pull request from development into main.

No additional files or uploads are required.

Evaluation Criteria

This assignment is graded on completion and correct use of the Git workflow.

You will receive full credit if:

  1. Your repository exists and is linked to GitHub Classroom.
  2. A development branch exists with at least one commit.
  3. The required file is correctly updated.
  4. A pull request from development to main is open.
  5. Commit messages are reasonable and descriptive.

Notes on Course-Wide Requirements

  • Certification headers are not required for this assignment.
  • A reflection file is not required for this assignment.
  • Future assignments will require both unless stated otherwise.

Additional Resources

  • Git Documentation - Official documentation for Git, including detailed explanations of commands, workflows, and concepts. This is the authoritative reference for understanding how Git works under the hood.

  • GitHub Docs - Comprehensive documentation for using GitHub features such as repositories, branches, pull requests, issues, and authentication. This is especially useful for understanding the GitHub web interface.

  • GitHub Classroom Help - Documentation specific to GitHub Classroom, including how assignments are created, accepted, and linked to student repositories, as well as common troubleshooting guidance.

  • Git Command Cheat Sheet (PDF) - A concise, printable reference listing commonly used Git commands and workflows. This is helpful as a quick lookup while working on assignments.