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

docs(site): Add metaphor-free TL;DR to Introduction #608

Merged
merged 4 commits into from
May 5, 2023

Conversation

joriswitteman
Copy link
Contributor

@joriswitteman joriswitteman commented Apr 18, 2023

I had a lot of trouble understanding this page because it immediately forces me into a mental model of 'mutants' and 'mutations' that only serve to distract me from understanding the gist of mutation testing. Mutation itself is even confusing because it make me think of network calls that do data mutations. It also confuses me because it reminds me of mutable vs immutable approaches in code.

This TL;DR summarises the page in a neutral way, without references to metaphors, that I believe would have made me got the concept right away.

I had a lot of trouble understanding this page because it immediately forces me into a mental model of 'mutants' and 'mutations' that only serve to distract me from understanding the gist of mutation testing. Mutation itself is even confusing because it make me think of network calls that do data mutations. It also confuses me because it reminds me of mutable vs immutable approaches in code.

This TL;DR summarises the page in a way that I believe would have made me got the concept right away.
@netlify
Copy link

netlify bot commented Apr 18, 2023

Deploy Preview for stryker-mutator ready!

Name Link
🔨 Latest commit 3b69f75
🔍 Latest deploy log https://app.netlify.com/sites/stryker-mutator/deploys/64551dc109b57d00075fc15d
😎 Deploy Preview https://deploy-preview-608--stryker-mutator.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@rachied
Copy link
Contributor

rachied commented Apr 23, 2023

Mutation testing changes the return statements in your functions

I think this simplifies things a bit too much. Mutations can and do occur outside of return statements.

@joriswitteman
Copy link
Contributor Author

Mutation testing changes the return statements in your functions

I think this simplifies things a bit too much. Mutations can and do occur outside of return statements.

How about:

TL; DR: Mutation testing changes little parts of your code to change the outcome, to verify that the tests that cover them, actually fail properly as a result.

@rouke-broersma
Copy link
Member

@nicojs I'm not sure what to think of this. Personally I think the text we have now is fine, however we have a clear user request for clearer language so.. It's probably bias and we should do something with this.

Mutation testing introduces changes to your code, then runs your unit tests against the changed code. It is expected that your unit tests now fail. If they don't fail for a change in the code this indicates the code is not sufficiently covered by your tests.

@joriswitteman
Copy link
Contributor Author

@rouke-broersma What you're citing there sounds perfect to me. That isn't yet on the site, is it?

@rouke-broersma
Copy link
Member

No it's my proposal.

Copy link
Member

@nicojs nicojs left a comment

Choose a reason for hiding this comment

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

Thanks for your feedback. What do you think about my suggestion?

docs/General/introduction.mdx Outdated Show resolved Hide resolved
Co-authored-by: Nico Jansen <jansennico@gmail.com>
@rouke-broersma rouke-broersma changed the title Add metaphor-free TL;DR to Introduction docs(site): Add metaphor-free TL;DR to Introduction May 5, 2023
@rouke-broersma rouke-broersma merged commit 55373ab into stryker-mutator:develop May 5, 2023
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.

4 participants