diff --git a/doc/manual/primer/patches.txt b/doc/manual/primer/patches.txt index a3d0453f27b9c415a7dd1b14036803ac88f06472..098766ebbee0642d0d80b0821fd4bd9290a2b236 100644 --- a/doc/manual/primer/patches.txt +++ b/doc/manual/primer/patches.txt @@ -204,6 +204,19 @@ it or prompt for feedback. Please have patience, as many maintainers work on the project voluntarily and without compensation for the time that they spend doing these tasks. +@section primerpatchguide Guidelines for Submitting Patches + +- Each patch file should contain: + - A commit description that describes all of the changes. + - A separator line that contains three hyphens: <code>---</code> + - A summary of the changes produced by diffstat (optional) + - Another separator line (optional) + - The actual patch contents, containing a single change. + +- Each patch series should include: + - A summary of the patches in the series. + - Logically-related patches that contain incremental changes. + */ /** @file This file contains the @ref primerpatches page.