summaryrefslogtreecommitdiff
path: root/Documentation/source/contributing/workflow.rst
diff options
context:
space:
mode:
authorBertrand Yuan <189593334+bertyuan@users.noreply.github.com>2026-04-27 20:54:16 +0800
committerGitHub <noreply@github.com>2026-04-27 20:54:16 +0800
commit85b6fb59db5fe1112c58eff9d02ae4f9c9b6456d (patch)
tree8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/contributing/workflow.rst
parent658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff)
parentdbb5e791f0c228369605d126dd590962ebe1eddc (diff)
Merge pull request #21 from bertyuan/Documentationv1.2
docs: add comprehensive documentation for operations
Diffstat (limited to 'Documentation/source/contributing/workflow.rst')
-rw-r--r--Documentation/source/contributing/workflow.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/Documentation/source/contributing/workflow.rst b/Documentation/source/contributing/workflow.rst
new file mode 100644
index 0000000..8457cbd
--- /dev/null
+++ b/Documentation/source/contributing/workflow.rst
@@ -0,0 +1,42 @@
+Workflow
+========
+
+Before Coding
+-------------
+
+1. Identify which subsystem owns the change.
+2. Read the nearest existing implementation and tests.
+3. Decide whether the change affects runtime behavior, schema, UI, docs, or
+ operations.
+4. Keep the patch scoped to the requested behavior.
+
+During Implementation
+---------------------
+
+* Follow local patterns before introducing new abstractions.
+* Keep data fetching in server routes or ``src/lib`` helpers.
+* Use existing UI primitives and tokens.
+* Update tests when behavior changes.
+* Update this documentation when a public contract, architecture, or workflow
+ changes.
+
+Before Submitting
+-----------------
+
+Run the most relevant checks:
+
+.. code-block:: bash
+
+ pnpm lint
+ pnpm test
+ make -C Documentation html
+
+For schema changes, include the appropriate migration and generated type
+updates.
+
+Review Expectations
+-------------------
+
+Reviews should prioritize correctness, behavior regressions, missing tests,
+security-sensitive configuration, and unclear contracts. Style comments should
+point to an existing repository convention or a maintainability issue.