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

Create compared-testing-frameworks topic outline #2112

Open
daaimah123 opened this issue Nov 26, 2024 · 3 comments · May be fixed by #2129
Open

Create compared-testing-frameworks topic outline #2112

daaimah123 opened this issue Nov 26, 2024 · 3 comments · May be fixed by #2129
Assignees
Labels
current-cohort-participant the participants can work on this issue

Comments

@daaimah123
Copy link
Collaborator

daaimah123 commented Nov 26, 2024

Week 8, participants are introduced to new testing frameworks and there is no clear comparison of them all and their usecases.

Page where problem found?

Add a compared-testing-frameworks topic outline here

Type of problem

It may not be clear to participants when to use the various testing frameworks.

Suggested Solution

  • Create a topic outline that clarifies the differences between RTL, jest, vite, super test & when to use them.
  • Provide examples
  • Answer the following questions
    • What is the difference between unit and integration testing?
    • What makes up a test suite?
  • Leverage the information from the chart in this day doc, supertest is not in the chart
  • Add a supplemental material section at the end with the following videos:
  • May be useful to include the following sections:
    • Questions to Consider
    • Prerequisites
    • Motivation or Real-World Application
    • Objectives
    • Common Mistakes / Misconceptions
    • Supplemental Materials

Acceptance Criteria

  1. Create a compared-testing-frameworks topic outline
    The issue suggests creating a topic outline that clarifies the differences between RTL, Jest, Vitest, SuperTest, and when to use them. This outline should provide examples and address specific questions like:

    • What is the difference between unit and integration testing?
    • What makes up a test suite?
  2. Add supplemental material
    Include the following videos in a supplemental materials section:

    • Intro to Jest: Object & API Testing
    • Jest Super Test Integration API Request Testing with Cristina Rodriguez
  3. Leverage existing chart information
    The issue mentions leveraging information from a day doc chart, specifically noting that Supertest is not in this chart. This suggests incorporating Supertest information into the comparison outline.

  4. Provide clear guidance on framework usage
    The ultimate goal is to clarify when to use each testing framework (RTL, Jest, Vitest, SuperTest). This should be clearly outlined in the topic outline.

  5. Address common testing concepts
    Ensure the outline covers fundamental testing concepts like:

    • Unit testing vs Integration testing
    • Test suite composition
    • Mocking and stubbing techniques
  6. Include practical examples
    Provide concrete examples demonstrating how to use each framework in different scenarios.

  7. Ensure compatibility information
    Include any necessary configuration or setup steps required for each testing framework to work properly within the project environment.

@daaimah123 daaimah123 added the current-cohort-participant the participants can work on this issue label Nov 26, 2024
@stmcpeters
Copy link
Collaborator

hey Daamiah! i've completed the instructions to become a curriculum contributor and would love to tackle this issue. can you please assign it to me? thanks 😄

@daaimah123
Copy link
Collaborator Author

Congratulations on becoming a contributor! 🎉

I have assigned the issue to you, @stmcpeters

@stmcpeters stmcpeters moved this from Grab a task!👩🏽‍💻 to In progress ⏲️ in Returning Grads PPW Kanban Board Dec 10, 2024
@stmcpeters
Copy link
Collaborator

hey @daaimah123 can you allow me access to view the day doc with the testing framework chart mentioned in the above issue. thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current-cohort-participant the participants can work on this issue
Projects
Status: In progress ⏲️
Development

Successfully merging a pull request may close this issue.

2 participants