Skip to content

Bug Hunt Exercise

In this assignment you'll practice finding defects in a small command-line application and documenting them using the standard bug report template. The goal is to sharpen your eye for issues and to provide clear, reproducible reports your teammates can act on.

Objectives

  1. Locate real bugs. Explore a purposely flawed CLI app and identify at least two defects.
  2. Write clear reports. Capture each issue using the bug report template.
  3. Provide evidence. Include screenshots or log snippets that prove the bug exists.

Setup

  1. Clone the sample repository: 
    git clone https://github.com/innovation-studio/buggy-cli-example.git
cd buggy-cli-example
  2. Review the README.md for any required dependencies and install them.
  3. Run the program with typical commands to see how it behaves.

Instructions

  1. Test the CLI features one by one. Note any crashes, incorrect output, or unexpected behavior.
  2. For each issue you uncover:
  3. Copy bug_report_template.md from the common_assets/templates folder into your project.
  4. Fill in the details—environment, steps to reproduce, expected vs. actual results, and severity.
  5. Save screenshots or logs that illustrate the problem and reference them in the report.
  6. Save each report as bug_report_<short-title>.md inside a BUG_REPORTS directory in the repo.
  7. Repeat until you have documented at least two distinct bugs.
  8. Commit your reports and screenshots to a new branch and push to your fork.
flowchart LR
    A[Clone repo] --> B[Run CLI app]
    B --> C[Find a bug]
    C --> D[Document using template]
    D --> E[Commit reports & screenshots]
    E --> F[Open pull request]

Deliverables

  1. At least two completed bug report files in BUG_REPORTS/.
  2. Supporting images or log files showing each issue.
  3. A short summary in your pull request describing the defects found.

Submission

Push your branch to GitHub and open a pull request. Reviewers will compare your reports to the example in sample bug reports and verify the issues are reproducible. Be prepared to discuss how you discovered each bug during the next stand‑up meeting.