diff options
| author | Gabriel Scherer <gabriel.scherer@gmail.com> | 2023-01-23 09:17:19 +0100 |
|---|---|---|
| committer | Gabriel Scherer <gabriel.scherer@gmail.com> | 2023-01-24 22:05:47 +0100 |
| commit | a8ab5d976a8d1400530c3af21ca5ba2fe4d1a6ae (patch) | |
| tree | 0c013e96437a2c4c1c5ae7469a46dcde8aed8e4f /CONTRIBUTING.md | |
| parent | f1550145d4ebe8ee22853d13f97fca288aaef51f (diff) | |
| download | ocaml-a8ab5d976a8d1400530c3af21ca5ba2fe4d1a6ae.tar.gz | |
emphasize that changes should be justified
Co-authored-by: Wiktor Kuchta <35867657+wiktorkuchta@users.noreply.github.com>
Co-authored-by: Florian Angeletti <florian.angeletti@inria.fr>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee6f2f6944..c4356c1f81 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -227,9 +227,14 @@ up to a few hours before the results are available on the results page. The description of the merge request must contain a precise explanation of the proposed change. -Before going in the implementation details, you should include -a summary of the change, and a high-level description of the design -of the proposed change, with example use-cases. +Before going into the implementation details, you should include +a summary of the change, a justification of why it is beneficial, and +a high-level description of the design of the proposed change with +example use cases. + +Changes have a cost, they require review work and may accidentally +introduce new bugs. Communicating as clearly as you can the benefits +of your PR will reassure and motivate potential reviewers. ### In the patches |