Home Support How to Write a Good Bug Report

How to Write a Good Bug Report

Last updated on Jul 01, 2025

Providing a clear and complete bug report helps us resolve your issue faster and more effectively. Below is a checklist of what to include when reporting a bug related to a Blackbird Extension.


✅ What to Include in Your Bug Report

1. Extension Information

  • Extension name
    (e.g., Cron Scheduler, Advanced Smtp, etc.)

  • Extension version
    (You can find this in the composer.json file or under Stores > Configuration > Blackbird in Magento Admin.)

2. Magento Environment

  • Magento version
    (e.g., 2.4.7-p2)

  • PHP version

  • Hosting environment
    (e.g., local dev, production server, cloud hosting)

3. Steps to Reproduce

Clearly describe how we can reproduce the issue:

1. Go to...
2. Click on...
3. Expecting...
4. Instead I see...

4. Expected vs Actual Behavior

Explain what you expected to happen and what actually happened:

  • Expected: “The cron job should appear in the job grid.”

  • Actual: “The cron job is missing, and the log shows an error.”

5. Error Messages or Logs

Include any relevant error messages or logs:

  • System log (var/log/system.log)

  • Exception log (var/log/exception.log)

  • Browser console errors

  • PHP or NGINX/Apache errors if applicable

6. Screenshots or Screen Recordings (if possible)

Visuals help us understand the issue faster. You can upload:

  • A screenshot of the error or unexpected behavior

  • A short screen recording of the steps to reproduce the bug

7. Other Relevant Info

  • Any recent changes to your Magento environment

  • Whether other extensions may be involved

  • Whether you’ve tried basic troubleshooting (e.g., cache flush, reindex, deploy)


🧪 Bonus: Reproducible Example

If possible, try to reproduce the issue on a clean Magento installation or staging site. Let us know the result—this helps us rule out conflicts with other custom code or extensions.


📨 Where to Send It

You can submit your bug report:


A clear bug report helps us help you faster 🚀.
Thanks for working with us to improve Blackbird Extensions!