summaryrefslogtreecommitdiff
path: root/Documentation/source/ja/contributing.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/ja/contributing.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/ja/contributing.rst')
-rw-r--r--Documentation/source/ja/contributing.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/source/ja/contributing.rst b/Documentation/source/ja/contributing.rst
new file mode 100644
index 0000000..cfd63bc
--- /dev/null
+++ b/Documentation/source/ja/contributing.rst
@@ -0,0 +1,38 @@
+コントリビューション
+====================
+
+作業フロー
+----------
+
+1. 変更を所有するサブシステムを判断する。
+2. 近い実装とテストを読む。
+3. 実行時動作、schema、UI、ドキュメント、運用手順への影響を確認する。
+4. patch は対象の挙動に絞り、無関係なリファクタリングを避ける。
+
+コミットメッセージ
+------------------
+
+推奨形式:
+
+.. code-block:: text
+
+ <type>(<scope>): <short summary>
+
+よく使う type は ``build``、``ci``、``docs``、``feat``、``fix``、``perf``、``refactor``、``test`` です。summary は命令形の現在形で書き、末尾にピリオドを付けません。
+
+コード完全性
+------------
+
+* リリースでは署名付き commit と署名付き tag を優先する。
+* 秘密情報、ローカル DB 状態、ビルド成果物をコミットしない。
+* 依存関係の変更はソース変更と同じ慎重さでレビューする。
+* 重要な変更はブランチで作業し、テストとドキュメントビルドを通す。
+
+提出前チェック
+--------------
+
+.. code-block:: bash
+
+ pnpm lint
+ pnpm test
+ make -C Documentation html