Lab 2

Lab 2#

Learning Objectives#

By the end of this lab, you will be able to:

  • Create and personalize your GitHub profile.

  • Set up a GitHub Pages website.

  • Contribute to an open-source project on GitHub.

  • Add a Google Colab badge to a Jupyter Notebook.

Exercise 1: Create Your GitHub Profile#

  1. Create a GitHub profile README by creating a new repository with the same name as your GitHub username.

  2. Add the following sections to your README:

    • Introduction: A short bio about yourself.

    • Interests and Hobbies: What excites you in tech and beyond.

    • Skills and Expertise: Your key technical and non-technical skills.

    • Social Media Links: Use badges to link to your profiles (e.g., Twitter, LinkedIn).

  3. Explore Markdown formatting to make your profile visually appealing.

💡 Example: Check out this GitHub profile README for inspiration: abhisheknaiidu/awesome-github-profile-readme

Exercise 2: Create a GitHub Pages Site#

  1. Create a new repository named YOUR-GITHUB-USERNAME.github.io. Replace YOUR-GITHUB-USERNAME with your actual GitHub username.

  2. Clone the repository to your local machine:

  3. Add an index.html file with basic HTML content. You can use a free template from HTML5 UP.

  4. Modify index.html to include:

    • A title and description of your site.

    • Links to your social media profiles.

    • An image or logo.

    • Any additional content you’d like to showcase.

  5. Commit and push your changes to the remote repository:

  6. Wait a few minutes for GitHub to deploy your site.

  7. Visit https://YOUR-GITHUB-USERNAME.github.io to see your site live.

💡 Example: Check out this GitHub Pages site for inspiration: https://giswqs.github.io

Exercise 3: Contribute to an Open-Source Project on GitHub#

  1. Find an open-source project that interests you. If you don’t know where to start, try this repository: giswqs/geog510-demo.

  2. Fork the repository to your GitHub account.

  3. Clone your forked repository to your local machine:

  4. Make improvements, such as:

    • Fixing typos or grammatical errors in documentation.

    • Adding a new Python script, Jupyter Notebook, or Markdown file.

    • Fixing bugs or enhancing existing code.

  5. Commit and push your changes to your forked repository.

  6. Create a pull request (PR) to the original repository, explaining your changes.

  7. Wait for the project maintainer to review and merge your PR.

Exercise 4: Add a Colab Badge to a Jupyter Notebook#

  1. Create a new GitHub repository or use an existing one.

  2. Add a Jupyter Notebook to the repository.

  3. Insert a Colab badge at the top of the notebook using this Markdown snippet:

    [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/USERNAME/REPOSITORY/blob/BRANCH/PATH_TO_NOTEBOOK.ipynb)

  4. Replace USERNAME, REPOSITORY, BRANCH, and PATH_TO_NOTEBOOK with the correct values for your notebook.

  5. Add content to the notebook (e.g., text, code cells, outputs).

  6. Commit and push your changes to the remote repository.

  7. Test the Colab badge by clicking it in your GitHub repository and verifying that it opens in Google Colab.

Submission Requirements#

Submit the following:

  1. A link to your GitHub profile README.

  2. A link to your GitHub Pages site.

  3. A link to your pull request for the open-source project.

  4. A link to your Jupyter Notebook with the Colab badge.

✅ Checklist Before Submission:

  • My GitHub profile README is informative and well-structured.

  • My GitHub Pages site is live and accessible.

  • My pull request has been created and includes meaningful contributions.

  • My Colab badge works, and the notebook runs without errors.

Good luck and happy coding! 🚀

Contents