Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
As a user of AVA you're the perfect candidate to help us improve our documentation. Typo corrections, error fixes, better explanations, more examples, etc. Open issues for things that could be improved. [Help translate our docs.](https://github.com/sindresorhus/ava-docs) Anything. Even improvements to this document.
As a user of AVA you're the perfect candidate to help us improve our documentation. Typo corrections, error fixes, better explanations, more examples, etc. Open issues for things that could be improved. [Help translate our docs.](https://github.com/avajs/ava-docs) Anything. Even improvements to this document.
Use the [`docs` label](https://github.com/sindresorhus/ava/labels/docs) to find suggestions for what we'd love to see more documentation on.
Use the [`docs` label](https://github.com/avajs/ava/labels/docs) to find suggestions for what we'd love to see more documentation on.
### Improve issues
@ -22,31 +22,31 @@ Some issues are created with missing information, not reproducible, or plain inv
We're always looking for more opinions on discussions in the issue tracker. It's a good opportunity to influence the future direction of AVA.
The [`question` label](https://github.com/sindresorhus/ava/labels/question) is a good place to find ongoing discussions.
The [`question` label](https://github.com/avajs/ava/labels/question) is a good place to find ongoing discussions.
### Write code
You can use issue labels to discover issues you could help out with:
* [`babel` issues](https://github.com/sindresorhus/ava/labels/babel) relate to our Babel infrastructure
* [`blocked` issues](https://github.com/sindresorhus/ava/labels/blocked) need help getting unstuck
* [`bug` issues](https://github.com/sindresorhus/ava/labels/bug) are known bugs we'd like to fix
* [`enhancement` issues](https://github.com/sindresorhus/ava/labels/enhancement) are features we're open to including
* [`performance` issues](https://github.com/sindresorhus/ava/labels/performance) track ideas on how to improve AVA's performance
* [`babel` issues](https://github.com/avajs/ava/labels/babel) relate to our Babel infrastructure
* [`blocked` issues](https://github.com/avajs/ava/labels/blocked) need help getting unstuck
* [`bug` issues](https://github.com/avajs/ava/labels/bug) are known bugs we'd like to fix
* [`enhancement` issues](https://github.com/avajs/ava/labels/enhancement) are features we're open to including
* [`performance` issues](https://github.com/avajs/ava/labels/performance) track ideas on how to improve AVA's performance
The [`help wanted`](https://github.com/sindresorhus/ava/labels/help%20wanted) and [`good for beginner`](https://github.com/sindresorhus/ava/labels/good%20for%20beginner) labels are especially useful.
The [`help wanted`](https://github.com/avajs/ava/labels/help%20wanted) and [`good for beginner`](https://github.com/avajs/ava/labels/good%20for%20beginner) labels are especially useful.
You may find an issue is assigned, or has the [`assigned` label](https://github.com/sindresorhus/ava/labels/assigned). Please double-check before starting on this issue because somebody else is likely already working on it.
You may find an issue is assigned, or has the [`assigned` label](https://github.com/avajs/ava/labels/assigned). Please double-check before starting on this issue because somebody else is likely already working on it.
We'd like to fix [`priority` issues](https://github.com/sindresorhus/ava/labels/priority) first. We'd love to see progress on [`low-priority` issues](https://github.com/sindresorhus/ava/labels/low%20priority) too. [`future` issues](https://github.com/sindresorhus/ava/labels/future) are those that we'd like to get to, but not anytime soon. Please check before working on these since we may not yet want to take on the burden of supporting those features.
We'd like to fix [`priority` issues](https://github.com/avajs/ava/labels/priority) first. We'd love to see progress on [`low-priority` issues](https://github.com/avajs/ava/labels/low%20priority) too. [`future` issues](https://github.com/avajs/ava/labels/future) are those that we'd like to get to, but not anytime soon. Please check before working on these since we may not yet want to take on the burden of supporting those features.
### Hang out in our chat
We have a [chat](https://gitter.im/sindresorhus/ava). Jump in there and lurk, talk to us, and help others.
We have a [chat](https://gitter.im/avajs/ava). Jump in there and lurk, talk to us, and help others.
## Submitting an issue
- The issue tracker is for issues. Use our [chat](https://gitter.im/sindresorhus/ava) or [Stack Overflow](https://stackoverflow.com/questions/tagged/ava) for support.
- The issue tracker is for issues. Use our [chat](https://gitter.im/avajs/ava) or [Stack Overflow](https://stackoverflow.com/questions/tagged/ava) for support.
- Search the issue tracker before opening an issue.
- Ensure you're using the latest version of AVA.
- Use a clear and descriptive title.
@ -66,4 +66,4 @@ We have a [chat](https://gitter.im/sindresorhus/ava). Jump in there and lurk, ta
- Write a convincing description of why we should land your pull request. It's your job to convince us. Answer "why" it's needed and provide use-cases.
- You might be asked to do changes to your pull request. There's never a need to open another pull request. [Just update the existing one.](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md)
Note: when making code changes, try to remember AVA's mantra (stolen from Python) of having preferably one way to do something. For example, a request to add an alias to part of the API ([like this](https://github.com/sindresorhus/ava/pull/663)) will likely be rejected without some other substantial benefit.
Note: when making code changes, try to remember AVA's mantra (stolen from Python) of having preferably one way to do something. For example, a request to add an alias to part of the API ([like this](https://github.com/avajs/ava/pull/663)) will likely be rejected without some other substantial benefit.
// Those changes will be reverted in https://github.com/nodejs/node/pull/6537
// Revert #815 and #827 when the above changes land in Node.js
console.warn('WARNING: `npm link ava` detected: This breaks NYC coverage on early versions of Node 6.\nSee https://github.com/sindresorhus/ava/pull/815');
console.warn('WARNING: `npm link ava` detected: This breaks NYC coverage on early versions of Node 6.\nSee https://github.com/avajs/ava/pull/815');
Even though JavaScript is single-threaded, IO in Node.js can happen in parallel due to its async nature. AVA takes advantage of this and runs your tests concurrently, which is especially beneficial for IO heavy tests. In addition, test files are run in parallel as separate processes, giving you even better performance and an isolated environment for each test file. [Switching](https://github.com/sindresorhus/pageres/commit/663be15acb3dd2eb0f71b1956ef28c2cd3fdeed0) from Mocha to AVA in Pageres brought the test time down from 31 sec to 11 sec. Having tests run concurrently forces you to write atomic tests, meaning tests don't depend on global state or the state of other tests, which is a great thing!
@ -10,7 +10,7 @@ Even though JavaScript is single-threaded, IO in Node.js can happen in parallel
Follow the [AVA Twitter account](https://twitter.com/ava__js) for updates.
Keep in mind that the `beforeEach` and `afterEach` hooks run just before and after a test is run, and that by default tests run concurrently. If you need to set up global state for each test (like spying on `console.log` [for example](https://github.com/sindresorhus/ava/issues/560)), you'll need to make sure the tests are [run serially](#running-tests-serially).
Keep in mind that the `beforeEach` and `afterEach` hooks run just before and after a test is run, and that by default tests run concurrently. If you need to set up global state for each test (like spying on `console.log` [for example](https://github.com/avajs/ava/issues/560)), you'll need to make sure the tests are [run serially](#running-tests-serially).
Remember that AVA runs each test file in its own process. You may not have to clean up global state in a `after`-hook since that's only called right before the process exits.
@ -589,7 +589,7 @@ We encourage you to use macros instead of building your own test generators ([he
You can use any assertion library instead of or in addition to the built-in one, provided it throws exceptions when the assertion fails.
This won't give you as nice an experience as you'd get with the [built-in assertions](#assertions) though, and you won't be able to use the [assertion planning](#assertion-planning) ([see #25](https://github.com/sindresorhus/ava/issues/25)).
This won't give you as nice an experience as you'd get with the [built-in assertions](#assertions) though, and you won't be able to use the [assertion planning](#assertion-planning) ([see #25](https://github.com/avajs/ava/issues/25)).
```js
import assert from 'assert';
@ -996,26 +996,26 @@ It's the [Andromeda galaxy](https://simple.wikipedia.org/wiki/Andromeda_galaxy).
Sindre Sorhus
9 years ago