Skip to content

feature: add docs for testing section #112

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

Merged
merged 11 commits into from
Jun 20, 2020
Merged

feature: add docs for testing section #112

merged 11 commits into from
Jun 20, 2020

Conversation

bencodezen
Copy link
Member

The proposal is here is not to serve as a comprehensive solution but provide some high level guidance for what people can expect in the testing ecosystem for Vue.js, but then route them to more in-depth guides for whatever topic they choose to dive into.

For example, @JessicaSachs and I had a conversation about distinguishing test runners from unit tests. While I wanted to include it in this section, I'm currently of the opinion that deeper guidance on testing methodologies and such should be rerouted to the Testing Team's own docs (which I will be happy to add contributions).

But the grander vision here is to give official testing resources a better platform where people can easily find those resources and work as a partner with them rather than try to replace them.

I look forward to your feedback!

@JessicaSachs
Copy link
Contributor

@bencodezen I remember we were considering having the 3rd party tool authors provide the blurbs for accuracy. Was that done?

@bencodezen
Copy link
Member Author

@bencodezen I remember we were considering having the 3rd party tool authors provide the blurbs for accuracy. Was that done?

@JessicaSachs Not yet. The descriptions from the 3rd party tools currently come from their website / own marketing with some editing (i.e., Jest's description is "Jest is a delightful JavaScript Testing Framework") of adjectives that seem more like subjective commentary (i.e., delightful).

I realized that contacting the various frameworks would be fair involved and didn't want to delay people having the chance to review it, but still certainly intend on doing so.

Do we have points of contact for these libraries beyond cold calling each website / GitHub maintainer?

Copy link
Contributor

@JessicaSachs JessicaSachs left a comment

Choose a reason for hiding this comment

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

I did a lot of rewording and only some content changes. I hope this helps! Please feel free to take what you need from the suggestions.


**Resources**

- [Official Vue Test Utils Documentation](https://vue-test-utils.vuejs.org)
Copy link
Member

Choose a reason for hiding this comment

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

We should link to the docs for VTU next: https://vuejs.github.io/vue-test-utils-next-docs/guide/introduction.html

VTU v1 is only for Vue 2.

Copy link
Member

Choose a reason for hiding this comment

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

I assume that eventually we'll merge both docs (to let users search through v1 docs), so the URL would be the same one.

Copy link
Member

@lmiller1990 lmiller1990 left a comment

Choose a reason for hiding this comment

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

Great, I like that we do not attempt to teach testing in the main docs anymore, but link to more detailed resources.

@lmiller1990
Copy link
Member

I think @JessicaSachs review is great. I left some random notes, I definitely agree we should not go too deep here and leave the heavy lifting to the respective libs and their own docs.

I remember we were considering having the 3rd party tool authors provide the blurbs for accuracy. Was that done?

For testing-library, @afontcu is maintaining that, maybe he could write something for this particular library.

@afontcu
Copy link
Member

afontcu commented Jun 5, 2020

Thanks for this! It looks great :) I've added several suggestions here and there, but I love the general tone.


The only thing I feel this docs are missing is mentioning that Vue Testing Library and Vue Test Utils run on top of a test runner such as Jest. I'm not entirely sure this is understandable right now, as it appears that Jest is only useful to run unit tests.

@JessicaSachs
Copy link
Contributor

JessicaSachs commented Jun 5, 2020 via email

bencodezen and others added 5 commits June 5, 2020 18:41
Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
Co-authored-by: Adrià Fontcuberta <afontcu@gmail.com>
bencodezen and others added 2 commits June 5, 2020 18:51
Co-authored-by: Adrià Fontcuberta <afontcu@gmail.com>
bencodezen and others added 2 commits June 5, 2020 18:55
Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
@bencodezen bencodezen merged commit 1e5f8fa into master Jun 20, 2020
@NataliaTepluhina NataliaTepluhina deleted the testing-guidance branch July 17, 2020 14:40
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