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

refactor(#637): Migrate testing utilities to Jest pt.1/X #1294

Merged
merged 9 commits into from
Apr 5, 2022

Conversation

joeyklee
Copy link
Contributor

@joeyklee joeyklee commented Feb 3, 2022

Dear ml5 community,

I'm making a Pull Request(PR). Please see the details below.

A good PR 🌟

β†’ Step 1: Describe your Pull Request πŸ“

Fixing a Bug? Adding an Update? Submitting a New Feature? Does it introduce a breaking change?

This PR adds the Jest testing framework/library to the ml5-library. This addresses a few elements for me in trying to be intentional about maintainability and approachability of testing for contributors.

I'm advocating for Jest largely because it is both the testing framework (e.g. Mocha or Jasmine) AND the testing assertion library (e.g. Chai) which I think makes it easier to reason about where to look up "how to do X" or "how to mock Y" and helps to create less "stuff" to manage.

It took me ages to finally figure out the differences between Mocha, jasmine, chai, and karma and I found it difficult to understand where the various testing functionalities started and ended. I think I might not be alone on this one!

So! This PR is part of a series of updates that integrates Jest as our testing framework.

I found these blogs helpful for reference:

@joeyklee joeyklee added the SEMVER/minor a version tag for a minor release change label Feb 3, 2022
@joeyklee joeyklee changed the title refactor(#637): WIP - Migrate testing utilities to Jest pt.1/X refactor(#637): Migrate testing utilities to Jest pt.1/X Feb 4, 2022
@joeyklee joeyklee requested review from bomanimc and shiffman February 4, 2022 01:57
@joeyklee joeyklee marked this pull request as ready for review April 5, 2022 21:23
@joeyklee
Copy link
Contributor Author

joeyklee commented Apr 5, 2022

Im going to get this process started with the knowledge that there might be some hiccups we'll have to address along the way. Thank you for your patience!

@joeyklee joeyklee merged commit ec62357 into main Apr 5, 2022
@joeyklee joeyklee deleted the joeyklee.637-migrate-to-jest branch April 5, 2022 21:27
joeyklee added a commit that referenced this pull request Apr 6, 2022
…est"

This reverts commit ec62357, reversing
changes made to e616a57.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SEMVER/minor a version tag for a minor release change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant