From dbb5e791f0c228369605d126dd590962ebe1eddc Mon Sep 17 00:00:00 2001 From: Bertrand Yuan Date: Mon, 27 Apr 2026 20:52:54 +0800 Subject: 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 --- Documentation/source/ja/contributing.rst | 38 ++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 Documentation/source/ja/contributing.rst (limited to 'Documentation/source/ja/contributing.rst') 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 は ``build``、``ci``、``docs``、``feat``、``fix``、``perf``、``refactor``、``test`` です。summary は命令形の現在形で書き、末尾にピリオドを付けません。 + +コード完全性 +------------ + +* リリースでは署名付き commit と署名付き tag を優先する。 +* 秘密情報、ローカル DB 状態、ビルド成果物をコミットしない。 +* 依存関係の変更はソース変更と同じ慎重さでレビューする。 +* 重要な変更はブランチで作業し、テストとドキュメントビルドを通す。 + +提出前チェック +-------------- + +.. code-block:: bash + + pnpm lint + pnpm test + make -C Documentation html -- cgit v1.2.3