Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guidelines for testing website components to the contributing guide #1249

Closed
wants to merge 1 commit into from

Conversation

rishipandey2
Copy link

What kind of change does this PR introduce?

This PR introduces new testing guidelines for writing tests for website components. It enhances the documentation for contributors who aim to write robust and consistent tests for the project.

Issue Number:

Screenshots/videos:

Not applicable.

If relevant, did you update the documentation?

Yes, I have updated the documentation by adding the test-writing guidelines to the CONTRIBUTING.md file.

Summary

This PR adds a section titled Guidelines for Writing Tests for Website Components to the CONTRIBUTING.md file. These guidelines aim to help contributors write clear, robust, and effective tests for website components. The key additions include:

  • Understanding the component's purpose.
  • Writing descriptive test cases.
  • Testing edge cases and unexpected inputs.
  • Following project standards for consistency.
  • Providing references for further learning.

This change ensures that contributors have a standardized approach to writing tests, improving the quality and maintainability of the project's codebase.

Does this PR introduce a breaking change?

No, this PR does not introduce any breaking changes.

@rishipandey2 rishipandey2 requested a review from a team as a code owner January 6, 2025 09:09
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

github-actions bot commented Jan 6, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

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

Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5114356) to head (5b840db).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1249   +/-   ##
=========================================
  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.

@benjagm
Copy link
Collaborator

benjagm commented Jan 7, 2025

Hi @rishipandey2 . I am going to close this PR as it has already been assigned to another contributor. Please follow the contributing guidelines before submitting a PR. Before sending a PR you need to be assigned to the issue.

@benjagm benjagm closed this Jan 7, 2025
@rishipandey2
Copy link
Author

Hi @benjagm
Thank you for the clarification and for pointing this out. I apologize for not following the contributing guidelines properly. I'll make sure to claim issues before submitting a PR in the future. I appreciate your guidance and look forward to contributing again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Add guidelines for writing tests for website components to the contributing guide
2 participants