7 Examples of Bug Reporting Template You Can Copy For Your Web Testing Process

Web testing is tough.

That’s why settling on a bug reporting process is necessary.

Whether your organisation need to report defect in a bug tracking app like JIRA, GitHub, Trello or keep a backlog in an Excel (xls) spreadsheet, a Word document (doc file) or via email, this post offers bug reporting templates you can copy and implement in your team. Find yours in this list:

There are man different elements you can include in your bug report, but here are the most important. Usually, the bigger your organization, the more detailed your reports need to be.

The indispensable elements are:

  • ID / Name: Keep it brief and use correct terms. A best practice is to include the name of the feature where you found an issue. A good example would be `CART – Unable to add new item to my cart`.
  • Description/ Summary: If you feel the name is not sufficient, briefly explain the bug with words. Phare it in a natural language. Keep in mind that your description might be used to search in your bug tracking application so be sure to use the correct language.
  • Environment: Depending on your browser, operating system, zoom level and screen size, websites may behave differently from one environment to another. Make sure your developers know your technical environment.
  • Source URL: Make it easy for your developers spot the problem by including the URL of the page where you found the bug. Big time saver!
  • Visual Proof: A picture is worth a thousand words. Although it might not be enough, a visual element like a screenshot or a video will help your developers understand the problem better and faster.
  • Steps to reproduce: A screenshot is a proof that you had a problem but keep in mind that your developer might not be able to reproduce the bug. Describe with as much detail as possible the steps you took before you encountered the bug.
  • Expected Results & Actual Results: Explain what results you expected and be as specific as possible. The app doesn’t work as expected is not useful. Also, describe what result you actually experienced.
  • Optional: You could also include extra information such as the severity (critical, major, minor, trivial, enhancement), the priority (high, medium, low), the name of the reporter, the person assigned or a due date.

Bugs can be reported in a number of ways. Using a bug tracker is probably the best way for your organization to move bugs from reported to fixed and help your developers stay focused.

1) Reporting Bugs In GitHub With Templates

A large number of developers out there use GitHub to build software in teams. The original goal of GitHub was to help developers to collaborate on code but as the services grew, they added more features to become a project management tools for building software. GitHub has an issue tracker built inside which makes it easy for developers to keep track of bugs.

Taking the elements form above, a well document GitHub issue should look like this:

github-bug-report-template

As you can imagine, filling out a bug report like this one can take a while. If you need to report dozen a bugs during a testing session, it could take you up to several hours.

Fortunately, you could speed up that process dramatically by using Marker for GitHub. Take a screenshot with Marker when you spot a problem on your website, add annotations to get your point across and the tool will convert it in 1-click into a GitHub issue. Technical information such as browser version, operating system, screen size and zoom level are automatically attached to your screenshot and converted into your GitHub issue without you having to do any extra work.

You can even use the built-in bug report template before creating your issue and fill out the steps to reproduce the bug as well as the expected and actual results.

marker-github-bug-reporting-template

If your team is on GitHub, consider signing up for a Marker free trial.

2) Reporting Bugs In JIRA With Templates

JIRA is a famous issue and project tracking software designed for development teams. It’s a bit complex for small teams but the reason why the most well know tech companies in the world use JIRA is because it is also very powerful.

I’m not going to review how JIRA works because it’s beyond the scope of this blog post. The important thing to understand is the concept of a JIRA issue is. In JIRA, an issue is a ticket that enters the system. It can be a project task, a Helpdesk ticket or a software bug.

Bugs can be reported anyone in the organization so it’s important to define a process and a template that everyone must use.

A well documented bug in JIRA looks something like this:

jira-bug-report-template

You can see that all elements of a well reported bug are present: Name/ID, Summary, Visual proof, Environment, Source URL, Steps to reproduce, Expected & Actual results.

As you can imagine, filling out a bug report like this one can take a while. If you need to report dozen a bugs during a testing session, it could take you up to several hours.

Fortunately, you could speed up that process dramatically by using Marker for JIRA. Take a screenshot with Marker when you spot a problem on your website, add an annotation to get your point across. Marker will convert it in 1-click into a JIRA issue. Technical information such as browser version, operating system, screen size and zoom level are automatically attached to your screenshot and converted into your JIRA issue without you having to do any extra work.

You can even use the built-in bug report template before creating your issue and fill out the steps to reproduce the bug as well as the expected and actual results.

jira-bug report template

If your team is already using JIRA, consider signing up for a Marker free trial.

3) Reporting Bugs In Trello With Templates

Trello is a free and super easy to use project management tool. Its ease of use is perfect for small of medium size organizations.

For your bug tracking purposes, simply set up a board called bug tracking. I recommend creating these lists : Reported, Accepted, In progress, To be validated, Done. You can even use labels to define the importance of your bugs (critical, major, minor, trivial, enhancement). You can then start to add Trello card for each bugs.

Taking the elements form above, a well document bug report in Trello should look like this:

trello-bug-report-template

Side note: I published a post on Trello’s blog about managing your bug tracking with Trello.

All elements of a well reported defect are present: Name, Summary, Visual proof, Environment, Source URL, Steps to reproduce, Expected & Actual results.

As you can imagine, filling out a bug report like this one can take a while. If you need to report dozen a bugs during a testing session, it could take you up to several hours.

Fortunately, you could speed up that process dramatically by using Marker for Trello. Take a screenshot with Marker when you spot a problem on your website, add annotations to get your point across and the tool will convert it in 1-click into a Trello card. Technical information such as browser version, operating system, screen size and zoom level are automatically attached to your screenshot and converted into your Trello card without you having to do any extra work.

You can even use the built-in bug report template before creating your card and fill out the steps to reproduce the bug as well as the expected and actual results.

Marker-trello-bug-report-template

If your team is already using Trello, consider signing up for a Marker free trial.

Alternative methods

As powerful as bug tracking tools are, the big problem is that you need everyone in the organization to use them. If you feel your organization is not ready to adopt these tools, more traditional methods such a using a spreadsheet or text can do the trick.

4) Excel: Reporting Bugs In Excel With Templates

Reporting bugs in a spreadsheet can be a cumbersome process. However, smaller teams can still benefits from this method. If you’re team decided to report and track bugs in Excel, it’s important to define a template that everyone in the organisations agrees to.

In this template, you will find all elements you need to report bugs in a structured way:

excel-xls-bug-report-template

Download the templates here:

5) Reporting Bugs In MS Word With Templates

Although not optimal, reporting bugs in a doc file can be a fast and structured way to report bugs to technical members on your team. As always, make sure that all elements are present. You don’t want your developers to come back to you asking for extra information.

Here is what your bug report template should look like:

word-file-doc-bug-report-template

Click here to view in Google docs or here to download the .doc file for MS Word

6) Reporting Bugs In PDF With Templates

Reporting bugs in a PDF file is similar to the previous point. PDFs are not very flexible but it might be a requirement to use them inside your organization. If that’s your case, feel free to copy our template.

I’ve prepared the document from above in a PDF file for you to download here

7) Reporting Bugs In E-mail With Templates

Most communication is still done through email. For example, if you’re a client of a web agency but the team did not give you a structured process to report bugs, you can always send them emails.
To make sure your emails always follow the same structure, you are better off saving this email template for bug reporting.

bug-report-email-template

Copy paste the content in this text file or download the txt file.

Conclusion

Web and software testing is tough. A lot of people from different background and expertise need to give their feedback. Miscommunication can lead to huge delay and growing frustration.
By establishing a process for reporting bug based on a fixed template, you remove those risks greatly.

Marker