Where to Report Bugs for Holehe: GitHub Issues and Templates Explained

Report bugs for Holehe through the repository's GitHub Issues tracker using the dedicated Bug report template located at .github/ISSUE_TEMPLATE/bug_report.md.

Holehe is an open-source OSINT tool that checks if an email address is registered on various websites. When you encounter errors or unexpected behavior while using the tool, knowing exactly where to report bugs for Holehe ensures maintainers can reproduce and fix issues efficiently. The project uses GitHub Issues as its official bug-tracking system, providing structured templates to streamline the reporting process.

Using the GitHub Issues Bug Report Template

The Holehe repository maintains a standardized bug reporting workflow through GitHub Issues. When you create a new issue in megadose/holehe, GitHub automatically presents the Bug report template, which mandates specific sections such as description, reproduction steps, environment details, and expected behavior.

This template resides in .github/ISSUE_TEMPLATE/bug_report.md within the repository root. According to the Holehe source code, using this template is the correct method for submitting defects, as opposed to the generic Feature request template intended for enhancements. The structured format helps developers triage problems faster by ensuring they receive consistent, actionable information.

Submitting Bug Reports via the GitHub CLI

You can initiate a bug report directly from the command line using the gh CLI tool. This method automatically applies the bug report template and associates the issue with the correct repository.

First, install and authenticate the GitHub CLI:

# Install gh CLI (macOS example)

brew install gh

# Or for Debian/Ubuntu

sudo apt install gh

# Authenticate with GitHub

gh auth login

Once authenticated, create the issue using the template flag:

gh issue create \
  --repo megadose/holehe \
  --title "Brief description of the bug" \
  --template bug_report.md

The --template bug_report.md parameter specifically invokes the template defined in the repository's .github/ISSUE_TEMPLATE/ directory, ensuring your submission follows the project's required format.

Anatomy of an Effective Bug Report

After invoking the template, you must fill in the predefined sections. The template requires clear descriptions of the defect, reproducible steps, and environmental context.

Here is an example of properly formatted content following the Holehe bug report structure:

**Describe the bug**
The `holehe` command crashes when processing a Gmail address containing a plus sign.

**To Reproduce**
1. Run `holehe test+alias@gmail.com`
2. Observe the traceback indicating an encoding error

**Expected behavior**
The command should handle the plus-sign alias correctly and return valid results without crashing.

**Additional context**
Running on Python 3.11 on Ubuntu 22.04.

Including specific details such as Python version, operating system, and the exact command that triggered the error allows maintainers to reproduce the environment accurately. The README.md file in the repository root provides general project overview and links to the issue tracker, while the bug report template focuses specifically on defect documentation.

Key Files Related to Issue Tracking

Several files in the Holehe repository govern how bugs are reported and tracked:

• .github/ISSUE_TEMPLATE/bug_report.md — The official bug report template that structures GitHub Issues submissions with required fields for reproduction steps and environment details.

• README.md — Contains project overview and general usage instructions; references the issue tracker for bug submissions.

• .github/FUNDING.yml — Documents support channels for the project, though it does not directly handle bug reporting workflows.

These files collaborate to define the contribution workflow, with bug_report.md serving as the primary interface between users and maintainers for defect resolution.

Summary

• Report bugs for Holehe exclusively through the GitHub Issues system at megadose/holehe.

• Use the Bug report template located at .github/ISSUE_TEMPLATE/bug_report.md to ensure structured submissions.

• The GitHub CLI (gh issue create --template bug_report.md) provides an efficient command-line method for creating templated issues.

• Include specific reproduction steps, environment details (Python version, OS), and expected vs. actual behavior to facilitate rapid debugging.

• Avoid using the Feature request template for defects, as the bug report template contains fields specifically designed for error triage.

Frequently Asked Questions

How do I know if I should file a bug report or a feature request?

If the software crashes, produces incorrect results, or fails to execute as documented, file a Bug report using the template at .github/ISSUE_TEMPLATE/bug_report.md. If you want to suggest new functionality or improvements to existing features, use the Feature request template instead. The bug report template includes specific sections for error tracebacks and reproduction steps that are unnecessary for feature discussions.

Can I report bugs via email or social media instead of GitHub Issues?

According to the Holehe source code and repository structure, GitHub Issues is the official bug-tracking system. While the README.md may provide general project information, the maintainers explicitly track defects through the GitHub Issues workflow using the .github/ISSUE_TEMPLATE/bug_report.md template. Using this centralized system ensures your report receives attention from the development team and remains visible to the community.

What information is mandatory when filling out the bug report template?

The template at .github/ISSUE_TEMPLATE/bug_report.md requires a description of the bug, steps to reproduce the issue, expected behavior versus actual results, and details about your environment (operating system and Python version). Providing minimal reproduction cases, such as the specific email address or command that triggered the error, significantly increases the likelihood of a timely fix.

Is there a way to check if my bug has already been reported before creating a new issue?

Before creating a new issue using gh issue create or the web interface, search existing issues in the megadose/holehe repository using keywords related to your error message or the specific module affected. The GitHub Issues search functionality filters open and closed issues, helping you identify if the maintainers are already tracking the defect or if a fix exists in a pending pull request.

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