|
1 | | -*develop.txt* For Vim version 9.1. Last change: 2025 Sep 07 |
| 1 | +*develop.txt* For Vim version 9.1. Last change: 2025 Sep 29 |
2 | 2 |
|
3 | 3 |
|
4 | 4 | VIM REFERENCE MANUAL by Bram Moolenaar |
@@ -388,7 +388,7 @@ unreliable, fails on major platforms (e.g., macOS), and is only part of the |
388 | 388 | new release workflow. In practice, contributors edit the relevant `.pro` files |
389 | 389 | by hand when adding, removing, or modifying a function signatures. |
390 | 390 |
|
391 | | -This system has been in place since at least v1.24, when Vim’s functions were |
| 391 | +This system has been in place since at least v1.24, when Vim's functions were |
392 | 392 | still written in K&R style. |
393 | 393 |
|
394 | 394 | ============================================================================== |
@@ -424,6 +424,14 @@ The basic steps to make changes to the code: |
424 | 424 | For any non-trivial change, please always create a pull request on github, |
425 | 425 | since this triggers the test suite. |
426 | 426 |
|
| 427 | +A PR should ideally contain a single commit for a single logical change. |
| 428 | +However, you can include several commits if you want to group multiple logical, |
| 429 | +atomic changes in one PR. This can also make longer PRs easier to review. Be |
| 430 | +sure to describe the reasoning for your changes in each commit message, as |
| 431 | +this greatly helps with the review process. In cases where each commit |
| 432 | +handles different logical changes, they will also be applied as separate |
| 433 | +patches in Vim's repository. |
| 434 | + |
427 | 435 | *style-clang-format* |
428 | 436 | sound.c and sign.c can be (semi-) automatically formatted using the |
429 | 437 | `clang-format` formatter according to the distributed .clang-format file. |
|
0 commit comments