ISSUE-206 # Add framework comparison guide (COMPARISONS.md)

[Aryan-Rustagi]

Fixed Which Issue?

• Which issue or ticket was(will be) fixed by this PR? (capture the issue link here)

PR Branch
#ADD LINK TO THE PR BRANCH

Motivation and Context

Checklist:

• 1. New Unit tests were added

  • 1.1 Covered in existing Unit tests

• 2. Integration tests were added

  • 2.1 Covered in existing Integration tests

• 3. Test names are meaningful

• 3.1 Feature manually tested and outcome is successful

• 4. PR doesn't break any of the earlier features for end users

  • 4.1 WARNING! This might break one or more earlier earlier features, hence left a comment tagging all reviewrs

• 5. PR doesn't break the HTML report features directly

  • 5.1 Yes! I've manually run it locally and seen the HTML reports are generated perfectly fine
  • 5.2 Yes! I've opened the generated HTML reports from the /target folder and they look fine

• 6. PR doesn't break any HTML report features indirectly

  • 6.1 I have not added or amended any dependencies in this PR
  • 6.2 I have double checked, the new dependency added or removed has not affected the report generation indirectly
  • 6.3 Yes! I've seen the Sample report screenshots here, and HTML report of the current PR looks simillar.

• 7. Branch build passed in CI

• 8. No 'package.*' in the imports

• 9. Relevant DOcumentation page added or updated with clear instructions and examples for the end user

  • 9.1 Not applicable. This was only a code refactor change, no functional or behaviourial changes were introduced

• 10. Http test added to http-testing-examples module(if applicable) ?

  • 10.1 Not applicable. The changes did not affect HTTP automation flow

• 11. Kafka test added to kafka-testing-examples module(if applicable) ?

  • 11.1 Not applicable. The changes did not affect Kafka automation flow

[Aryan-Rustagi]

Description

This PR resolves Issue #206 by adding a COMPARISONS.md file to the repository.

The document outlines the key differences and advantages of Zerocode over other popular testing frameworks like Rest Assured and Karate.

Key Highlights

• Compares Zerocode vs. Rest Assured and Karate.
• Focuses on Zerocode's core value proposition: simplicity, JSON-driven testing, and reduced Java boilerplate.
• Makes it easier for new users to understand why they should choose Zerocode.

Related Issue

Fixes #206

[authorjapps]

...

Related Issue

Fixes #206

CI is running... it shd pass as there are no code changes!

Thanks for picking this up @Aryan-Rustagi , we'll need a similar change(PR) in the Documentation repo as well.
Do you want me to raise a new ticket for this or you can figure out yourself from earlier PRs?

Remember to raise a new Issue(ticket) for visibility purpose please.

[Aryan-Rustagi]

Thanks for the feedback @authorjapps! I'm glad the comparisons document looks good.

I will raise a new issue for the documentation repo change and submit a PR there as well. I'll link both here once they're created

[authorjapps]

@Aryan-Rustagi , As you've done a great job putting together such an honest and useful comparison... also you've already done the groundwork, I think this could make a really valuable blog post too.

If you're up for it, consider turning the comparison into a blog on Medium, DZone, or another platform of your choice. It could be a great way to share your experience with other Devs and SDETs who are evaluating automation frameworks and looking for practical guidance to simplify their automation journey, save time, and ultimately ship releases to production with greater confidence.

And no pressure at all... consider it whenever you feel like taking it up. Once you're happy with the post, you can also add the link here:

It would be great to see your first contribution evolve into something that helps the wider testing community as well.
👋 Happy to help if you need a hand with anything along the way!