summaryrefslogtreecommitdiff
path: root/Documentation/source/operations/quality.rst
diff options
context:
space:
mode:
authorBertrand Yuan <me@bertyuan.com>2026-04-27 20:52:54 +0800
committerBertrand Yuan <me@bertyuan.com>2026-04-27 20:53:14 +0800
commitdbb5e791f0c228369605d126dd590962ebe1eddc (patch)
tree8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/operations/quality.rst
parent658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff)
docs: add comprehensive documentation for operations
This commit introduces a complete set of documentation files covering various aspects of the project, including environment setup, quality checks, command references, and architecture. The documentation is structured to assist developers and contributors in understanding the project's configuration, workflow, and best practices. Additionally, translations for Simplified and Traditional Chinese have been added to ensure accessibility for a wider audience. This enhances the overall usability and maintainability of the project. Signed-off-by: Bertrand Yuan <github@bertyuan.com>
Diffstat (limited to 'Documentation/source/operations/quality.rst')
-rw-r--r--Documentation/source/operations/quality.rst56
1 files changed, 56 insertions, 0 deletions
diff --git a/Documentation/source/operations/quality.rst b/Documentation/source/operations/quality.rst
new file mode 100644
index 0000000..4be1cfd
--- /dev/null
+++ b/Documentation/source/operations/quality.rst
@@ -0,0 +1,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.