update the readme

This commit is contained in:
Frank Elsinga 2026-01-01 16:51:02 +01:00
parent ac1c43d2cc
commit d493291025

View File

@ -4,14 +4,26 @@ Documentation: https://nodejs.org/api/test.html
Create a test file in this directory with the name `*.js`.
> [!TIP]
> Writing great tests is hard.
>
> You can make our live much simpler by following this guidance:
> - Use `describe()` to group related tests
> - Use `test()` for individual test cases
> - One test per scenario
> - Use descriptive test names: `function() [behavior] [condition]`
> - Don't prefix with "Test" or "Should"
## Template
```js
const test = require("node:test");
const { describe, test } = require("node:test");
const assert = require("node:assert");
test("Test name", async (t) => {
assert.strictEqual(1, 1);
describe("Feature Name", () => {
test("function() returns expected value when condition is met", () => {
assert.strictEqual(1, 1);
});
});
```