Exercise - Connect the dots in a GitHub repository

In this lab, you will learn how to connect different pieces of work in a GitHub repository. GitHub provides powerful features to link issues, pull requests, and commits, helping you track relationships between different items and create a clear picture of your project's progress.

You will learn how to:

  • Link issues and pull requests
  • Reference commits in conversations
  • Use keywords to automatically close issues
  • Create relationships between work items
  • Track work through connected items
  • Organize and navigate repository work

This lab takes approximately 30 minutes to complete.

Before you start

To complete the lab, you need:

  • A GitHub user account. If you don't have one, you can create a new account. If you need instructions on how to create a GitHub account, refer to the article Creating an account on GitHub.
  • Basic understanding of issues and pull requests.
  • A web browser with access to the internet.

Complete the exercise on GitHub

In this exercise, you'll learn to connect and reference work items through a hands-on GitHub Skills exercise.

Note: This exercise is hosted on GitHub Skills and provides an interactive learning experience. You'll practice linking issues to pull requests, using closing keywords, and organizing work effectively.

The exercise consists of the following activities:

  1. Start a web browser and navigate to the exercise repository: https://github.com/skills/connect-the-dots

  2. On the exercise page, select the Use this template button to copy the exercise to your GitHub account.

    Note: Simply copy the exercise to your account, then give GitHub about 20 seconds to prepare the first lesson, then refresh the page.

  3. Follow the instructions on the repository's README to complete all the challenges, which include:

    • Creating issues to track work
    • Referencing issues in pull requests and comments
    • Using closing keywords like "fixes #1" or "closes #2"
    • Linking pull requests to specific issues
    • Understanding automatic issue closure when PRs are merged
    • Cross-referencing between different issues and PRs
    • Navigating relationships between connected items

  4. Work through each step in the exercise, following the prompts and instructions provided.

    Note: Learning to connect work items helps maintain clear traceability and makes project management more effective.

  5. When you finish all the challenges, you'll understand how to organize and connect work in GitHub repositories.

What you've learned

After completing this exercise, you should be able to:

  • Create and reference issues effectively
  • Link pull requests to related issues
  • Use closing keywords to automatically close issues
  • Navigate relationships between work items
  • Track work through connected items
  • Maintain clear traceability in projects
  • Use references to create project documentation
  • Organize repository work efficiently

Congratulations! You've completed the "Connect the dots in a GitHub repository" exercise and learned how to effectively link and organize work!