Add Quick Guide for Writing Tests to Contributing Documentation

[yadavshubham01]

This pull request adds a new section to the contributing-docs.md file, providing a quick guide for writing effective tests. It includes best practices for test structure, naming conventions, and details on creating tests with Cypress, both for components and end-to-end (E2E) scenarios. Additionally, it provides resources for further reading on test writing.

How This Solves the Issue:
The enhancement improves the contributing-docs.md documentation by adding clear, concise instructions for contributors on how to write and structure tests. This ensures that new contributors have a reliable reference for implementing tests alongside their contributions, promoting consistency and quality in test coverage. The addition of this guide helps maintain robust and maintainable tests across the project.

Issue Number:

• Closes [📝 Docs]: Add guidelines for writing tests for website components to the contributing guide #1147

[github-actions]

Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.

[yadavshubham01]

hey @benjagm please review this PR

[github-actions]

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name	Status	Preview	Last Commit
website	✅ Ready (View Log)	Visit Preview	6440482

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5114356) to head (6440482).

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #1151   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          373       373           
  Branches        94        94           
=========================================
  Hits           373       373           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kurtmckee]

@yadavshubham01 I noticed that you repeatedly edited your "please review this PR" request to @-mention different people, including me in one edit.

1. I've never contributed to this repo to the best of my knowledge. Your manual effort to ping me was unnecessary.

2. I see from your GitHub activity that you consistently, and immediately, ping people on every PR you open on GitHub.

   Please stop doing this. As demonstrated here, it's error prone (you might ping people who have nothing to do with the repo), and is unnecessary because repo owners typically receive notifications about PRs opened.

Thanks for your work to contribute to open source! I wish you well.

[yadavshubham01]

Apologies for the inconvenience, I will be more careful next time

[gregsdennis]

Please hold on this while we discuss in the issue. cc: @valeriahhdez

[valeriahhdez]

Hello @yadavshubham01,

Thank you for your work on this PR. The triage team reviewed issue #1147 and found that the project's needs were not clearly described and incorrectly pointed to the CONTRIBUTING-docs.md file as the place to document test guidelines.

Here are the key points from the triage team's review:

• Issue [📝 Docs]: Add guidelines for writing tests for website components to the contributing guide #1147 addresses the lack of guidelines on writing tests for the website's components.
• The guidelines should be documented in the CONTRIBUTING.md guide, not in the CONTRIBUTING-docs.md.

If you still want to work on issue #1147 we kindly ask you to commit your changes to the CONTRIBUTING.md guide. We apologize for any inconvenience caused. The maintainer's team had not yet triaged the issue when you opened the PR.

To prevent similar situations in the future, we are adding a new rule to our CONTRIBUTING.md guide: contributors should wait until a project maintainer assigns them to an issue before starting work on the changes.

Thank you for your understanding and have a nice day.

[yadavshubham01]

hey @valeriahhdez i will make change in CONTRIBUTING.md

[yadavshubham01]

hey @valeriahhdez please review i fix that changes in CONTRIBUTING.md

[benjagm]

I dont see the benefit of adding generic information about testing, lets please avoid that.

We already have the contributing to testing section with some basic guidelines about how to add tests to your code but it seems that is not enough. My expectation is to add some more tech details for everyone to understand how to implement the tests for their code when contributing to the project.