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

Add test style guide #1918

Merged
merged 5 commits into from Mar 15, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions website/style_guide.md
Expand Up @@ -262,3 +262,30 @@ the first column of the comment. For example:

Code examples should not contain additional comments. It is already inside a
comment. If it needs further comments is not a good example.

## Each module should come with tests

Each module should come with its test as a sibling with the name
`modulename_test.ts`. For example the module `foo.ts` should come with its
sibling `foo_test.ts`.

## Unit Tests should be explicit

For a better understanding of the tests, function should be correctly named as
its prompted throughout the test command. Like:

```
test myTestFunction ... ok
```

Example of test:

```ts
import { assertEquals } from "https://deno.land/std@v0.3.1/testing/asserts.ts";
import { test } from "https://deno.land/std@v0.3.1/testing/mod.ts";
import { foo } from "./mod.ts";

test(function myTestFunction() {
assertEquals(foo(), { bar: "bar" });
});
```