Document common pitfalls

[jamestalmage]

There are some points that continue to confuse people (especially as it relates to our async behavior).

One in particular is using closure scope variables to try and pass data between beforeEach and individual tests (see #402).

I think we need to create some documentation that addresses each of these types misconceptions so we can quickly link to them. They can be in the readme if they are concise, but maybe separate documents if they require lengthy explanations.

If anyone can think of other common downfalls / misconceptions / misuses - go ahead and add them to this discussion.

[ariporad]

I think this is a really great idea. Also, I'd like to appreciate the relevant issue number.

[sindresorhus]

Good idea!

[sindresorhus]

Pitfalls:

• Using global variables and forgetting that tests run concurrently.
• console.log not logging where the test result is printed (I hope we can fix Default reporter swallows console.log #392, but we should document until we do)

[ariporad]

Actually, What if we made this a wiki page and linked to it from the README? That way others could contribute?

[sindresorhus]

What if we made this a wiki page and linked to it from the README?

No. I want to have quality control on the docs. I don't want random strangers to be able to just freely modify the docs. Also: https://plus.google.com/+sindresorhus/posts/QSS2du26Mg4

That way others could contribute?

They already can with a pull request.

[novemberborn]

Another one: if you run AVA in Docker as part of your CI, you need to forward the appropriate environment variables (see https://github.com/watson/is-ci/blob/master/index.js), or configure the verbose reporter. See #751.

[sotojuan]

Should we make a common_pitfalls.md in the documentation directory with these?

[jamestalmage]

yep