Need Help? Create a GitHub Issue

Need Help? Create a GitHub Issue#

If you run into any problems — whether it’s with the notebook, the Jupyter Book, live coding, or instructions — you can let us know by opening a GitHub issue.

Method 1: from the Jupyter Book#

open_issue

  1. From the Jupyter book, you can navigate to the top bar where the GitHub icon is, and click on “Open Issue”.

  2. A title will automatically be generated based on the module and page you are on from the jupyter book.

  3. In the description, include:

    • A short explanation of what the issue is

    • Where you encountered it (e.g. module, notebook, or section name)

    • A screenshot or code snippet if possible

Method 2: via the Repository#

locate_repo

  1. Select the repository button from the upper right GitHub button, or click on our course GitHub repository link: 👉 [HERE]

github_issues_tab 2. Click on the “Issues” tab.

github_issues_create 3. Click “New issue” (green button).

  1. Add a clear title, like: Broken image in Module 1 or Code example not working in Module 2

  2. Just like in method 1, in the description, include:

    • A short explanation of what the issue is

    • Where you encountered it (e.g. module, notebook, or section name)

    • A screenshot or code snippet if possible

  3. Click “Submit new issue”.

📣 Don’t worry if it’s small! Even small typos, broken links, or confusing instructions are super helpful for us to fix.

Contents