summaryrefslogtreecommitdiff
path: root/Documentation/source/ja/contributing.rst
blob: cfd63bced96ac164ea08bc90af8e5112b0cf7b44 (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
コントリビューション
====================

作業フロー
----------

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