summaryrefslogtreecommitdiff
path: root/Documentation/source/operations/quality.rst
blob: 4be1cfd119c3393e6c8799c7f38be58a803c6a11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Quality
=======

Tooling
-------

.. list-table::
   :header-rows: 1
   :widths: 20 54

   * - Tool
     - Role
   * - Vitest
     - Unit and component tests.
   * - Testing Library
     - DOM-oriented component assertions.
   * - Biome
     - Linting and formatting checks.
   * - ``scripts/lint.mts``
     - Project-specific content and link validation.
   * - TypeScript
     - Static type checking through project build and editor tooling.

Common Checks
-------------

.. code-block:: bash

   pnpm lint
   pnpm check
   pnpm test
   pnpm build

Testing Guidance
----------------

Add tests when a change affects:

* shared UI components;
* route-visible behavior;
* metadata generation;
* validation logic;
* content transformation;
* pagination;
* authentication or comment policy boundaries.

Keep tests focused on observable behavior. Avoid locking tests to incidental
implementation details unless the implementation itself is the contract.

CI Direction
------------

A complete CI gate should run lint, tests, type-sensitive build checks, and
documentation build checks. If a command requires external secrets, provide a
mocked or validation-skipped CI mode rather than weakening production
validation.