How to Report a Bug in AI For Beginners: A Step-by-Step Guide

Open a GitHub issue using the appropriate template—Lesson Correction for content errors or Translation Feedback for localization problems—after searching existing issues to avoid duplicates.

The AI For Beginners repository by Microsoft maintains structured contribution workflows to ensure bugs are tracked and resolved efficiently. Whether you've spotted a typo in a Jupyter notebook, a broken code example, or an incorrect translation, the project provides dedicated issue templates to streamline the reporting process.

Search Existing Issues First

Before creating a new bug report, browse open issues in the repository. This prevents duplicate submissions and helps you identify if the problem is already being addressed. The repository's "Help Wanted" notice in README.md (line 63) explicitly encourages this step to keep the issue tracker manageable.

Choose the Right Issue Template

The project uses GitHub issue templates located in .github/ISSUE_TEMPLATE/ to categorize bug reports:

• Lesson Correction (lesson_correction.yml) — For errors in lesson notebooks, code snippets, broken links, or documentation inaccuracies.
• Translation Feedback (translation_feedback.yml) — For problems with localized content, mistranslations, or missing translations.

Selecting the correct template ensures maintainers receive the specific details they need to reproduce and fix the issue.

Submit Your Bug Report

1. Navigate to the repository's Issues tab and click "New issue".
2. Select either Lesson Correction or Translation Feedback from the template list.
3. Fill in all required fields, including:
   • Lesson name or file path
   • Detailed description of the error
   • Expected vs. actual behavior
   • Screenshot or code snippet if applicable
4. Click Submit new issue.

Here is a well-structured example for a lesson bug:

**Lesson Name or File Path**
lessons/3-NeuralNetworks/03-Perceptron/Perceptron.ipynb

**Correction Details**
The cell that imports `torch.nn` fails because the import statement is misspelled:

```python
import torc.nn   # <-- typo

It should be:

import torch.nn

## Optional: Submit a Pull Request

If you've already fixed the bug, you can bypass the issue and submit a **Pull Request** directly:

1. Fork the repository to your account.
2. Create a new branch with a descriptive name (e.g., `fix-perceptron-typo`).
3. Commit your changes with a clear message:

```text
fix: correct typo in Perceptron notebook import

- Fixed misspelled `torc.nn` to `torch.nn`
- Updated notebook cell output to reflect the change

4. Open a PR against the main branch.

The CLA-bot will automatically verify that you've signed the Microsoft Contributor License Agreement (CLA). See the CLA section in CONTRIBUTING.md for details.

Follow Up and Resolution

Maintainers may request clarification or additional testing. Once the fix is verified, the issue will be closed and (if applicable) your PR merged. The entire workflow is documented in CONTRIBUTING.md, which serves as the authoritative source for contribution guidelines.

Key Files for Bug Reporters

File	Purpose
CONTRIBUTING.md	Guides contributors on CLA signing, submission process, and coding standards.
.github/ISSUE_TEMPLATE/lesson_correction.yml	Structured template for lesson-specific bugs.
.github/ISSUE_TEMPLATE/translation_feedback.yml	Structured template for translation issues.
README.md	Contains the "Help Wanted" call-to-action and issue creation links.

Summary

• Search first to avoid duplicate bug reports in AI For Beginners.
• Use the Lesson Correction template for code and content errors; use Translation Feedback for localization problems.
• Provide specific details: file path, error description, and expected fix.
• Submit a PR directly if you've already resolved the bug, ensuring you sign the Microsoft CLA.
• Reference CONTRIBUTING.md for comprehensive contribution guidelines.

Frequently Asked Questions

Do I need to sign the Microsoft CLA to report a bug?

No. You only need to sign the Microsoft Contributor License Agreement if you submit code changes via Pull Request. Filing an issue using the templates requires no additional agreements.

What if my bug doesn't fit either template?

Use your best judgment to select the closer match and include additional context in the description field. For systemic issues affecting multiple lessons, describe the pattern clearly and reference multiple file paths.

How long does it take for bugs to get fixed?

Resolution time varies based on maintainer availability and issue complexity. Simple typos may be merged within days; structural problems requiring curriculum review may take weeks. Check the issue for maintainer comments requesting clarification.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}