diff --git a/doc/develop.jax b/doc/develop.jax index 287c7c4b6..17f709a59 100644 --- a/doc/develop.jax +++ b/doc/develop.jax @@ -1,4 +1,4 @@ -*develop.txt* For Vim バージョン 9.1. Last change: 2025 Sep 07 +*develop.txt* For Vim バージョン 9.1. Last change: 2025 Sep 29 VIMリファレンスマニュアル by Bram Moolenaar @@ -421,6 +421,13 @@ editorconfig プラグイン |editorconfig-install| と一緒に使用し、推 些細な変更でない場合は、必ず github でプルリクエストを作成すること。これによ り、テストスイートがトリガーされる。 +PR は理想的には 1 つの論理的変更に対する 1 つのコミットを含めるべきである。た +だし、複数の論理的かつ独立した変更を 1 つの PR にまとめたい場合は、複数のコミッ +トを含めることができる。これにより、長い PR のレビューも容易になる。各コミット +メッセージには、変更の理由を必ず記載すること。これはレビュープロセスに非常に役 +立つ。各コミットが異なる論理的変更を扱う場合、それらは Vim のリポジトリ内で別々 +のパッチとして適用されることになる。 + *style-clang-format* sound.c と sign.c は、配布された .clang-format ファイルに従って、 `clang-format` フォーマッタを使用して (半) 自動的にフォーマットできる。他のソー diff --git a/en/develop.txt b/en/develop.txt index 70176f831..52d07b10b 100644 --- a/en/develop.txt +++ b/en/develop.txt @@ -1,4 +1,4 @@ -*develop.txt* For Vim version 9.1. Last change: 2025 Sep 07 +*develop.txt* For Vim version 9.1. Last change: 2025 Sep 29 VIM REFERENCE MANUAL by Bram Moolenaar @@ -388,7 +388,7 @@ unreliable, fails on major platforms (e.g., macOS), and is only part of the new release workflow. In practice, contributors edit the relevant `.pro` files by hand when adding, removing, or modifying a function signatures. -This system has been in place since at least v1.24, when Vim’s functions were +This system has been in place since at least v1.24, when Vim's functions were still written in K&R style. ============================================================================== @@ -424,6 +424,14 @@ The basic steps to make changes to the code: For any non-trivial change, please always create a pull request on github, since this triggers the test suite. +A PR should ideally contain a single commit for a single logical change. +However, you can include several commits if you want to group multiple logical, +atomic changes in one PR. This can also make longer PRs easier to review. Be +sure to describe the reasoning for your changes in each commit message, as +this greatly helps with the review process. In cases where each commit +handles different logical changes, they will also be applied as separate +patches in Vim's repository. + *style-clang-format* sound.c and sign.c can be (semi-) automatically formatted using the `clang-format` formatter according to the distributed .clang-format file.