Add Quick Guide for Writing Tests to Contributing Documentation #1151
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
|
hey @benjagm please review this PR |
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
|
@yadavshubham01 I noticed that you repeatedly edited your "please review this PR" request to @-mention different people, including me in one edit.
Thanks for your work to contribute to open source! I wish you well. |
|
Apologies for the inconvenience, I will be more careful next time |
There was a problem hiding this comment.
Please hold on this while we discuss in the issue. cc: @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:
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. |
|
hey @valeriahhdez i will make change in CONTRIBUTING.md |
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: