process / Testing

Test Comments Best Practices

How to write effective test comments in JIRA tickets

When testing software, writing effective test comments in JIRA tickets is essential. It helps keep track of what's been tested, what needs fixing, and where things stand. Here are some tips for writing effective test comments:

1. Start with a clear message

Start with a clear message: Begin your comment by stating whether the ticket passed or failed QA verification.

Example:

✅ Ticket has passed QA verification.

2. Explain what went wrong (if failed)

If the ticket failed, provide a clear explanation of what went wrong. Use a numbered list to keep it organized.

Example:

🚫 Ticket failed due to the following reasons:

1. Login button not working
2. Broken links on the page
3. Unable to submit the form.

3. Use images and videos

Pictures and videos can help narrow down the issue and provide a visual representation of the problem.

Example:

Screenshot attached showing the broken links on the page.

4. Add a note for concerns/suggestions

If you have any concerns or suggestions, add a note and tag the relevant parties (@PM, @Dev) to bring it to their attention.

Example:

NOTE: Concerned about the load time on the page. Tagging @PM for further discussion.

5. Provide details for testing

List the test cases in the Test Results section, along with any preconditions, configurations, test environment & site, user data, etc., above the test cases. Add pass or fail to each tested case.

Example:

Tested On:

Test Site: stg.example.com User: joe@example.com / 111111

Test Results:

1. Login functionality - ✅ PASS
2. Form submission - 🚫 FAIL

Include screenshots: Include screenshots of your verification, either under the related test case or at the bottom, to provide further context. Example: "Screenshot attached showing the successful login."

6. Experiment with Formats and Use Templates

In addition to the tips mentioned above, it's also important to experiment with different formats for writing test comments and pick the one that works best for your team. Once you've found a format that's effective, save it as a template and reuse it for future test comments.

This will save time and ensure consistency in the way test comments are written. Don't be afraid to make changes and refine the template as needed based on feedback from the team.

Over time, you'll develop a standard for writing test comments that's tailored to your team's needs, and it will become a streamlined and efficient part of your software development process.

Summary

Remember to keep your test comments simple and organized. By following these tips, you can ensure effective communication and collaboration within the development team, and ultimately deliver high-quality software.

This will also make it easy for you to re-test and verify the ticket in the future.

Suggested Template

✅ Passed QA verification:

Tested On:

Site: https://www.techatlas.dev User: no auth required

Test Results:

1. My logo is displayed along with text message - ✅ pass
2. Author of the article is displayed - ✅ pass
3. Table of contents is displayed - ✅ pass