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

Improving the Testing Section of the Documentation #315

Open
1 of 4 tasks
SammyIsra opened this issue Jun 1, 2017 · 1 comment
Open
1 of 4 tasks

Improving the Testing Section of the Documentation #315

SammyIsra opened this issue Jun 1, 2017 · 1 comment
Labels

Comments

@SammyIsra
Copy link

SammyIsra commented Jun 1, 2017

This issue is a:

  • Bug report
  • Feature request
  • Question / support request
  • Other

The Testing Section of the documentation seems lacking. More specifically, the Example Test section does not provide an appropriate example test, since it doesn't even deal with React components and isn't really testing anything.

The document does not have enough information for someone that hasn't dealt much with testing before, and someone coming to it would have to go somewhere else to learn how to write tests for components scaffolded with nwb.

@insin
Copy link
Owner

insin commented Jun 1, 2017

The testing docs are about showing you what nwb's default test setup allows you to do in terms of where you put tests, which libraries are available by default, and how to change the testing setup to your liking via config, but they don't assume you know anything about what you're doing in the tests themselves.

I'd be happy to add a section up top with suitable resources for that if people have recommendations.

Example tests and projects for real React example code are shown in the React App guide and React Component guide, which we should link to from the testing docs as a next step. They're also a more suitable place to expand on the different testing approaches once nwb has built-in support for them.

e.g. I'd like to be able to include Enzyme by default for shallow render testing support (#119), provide a way to enable use of Jest as your main test runner and for snapshot testing (#173) and something else for end-to-end testing (#138)

@insin insin added the docs label Jun 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants