From 7da37962ced51497d9060c845b9f215fc67ec070 Mon Sep 17 00:00:00 2001 From: Giulio Benetti Date: Sun, 17 Sep 2023 22:51:07 +0200 Subject: [PATCH] docs/manual: add section to explain how to give credits to a sponsor Sometimes it happens that a Company or a Physical Person sponsors the creation and/or the upstreaming process of a patch, but at the moment there is no way to give credits to it. In Linux they prepend '+sponsor' to the e-mail of the contributor in both authorship and commit log tag as discussed here[0]. So let's describe in the manual how to do that as a standard. [0]: https://lore.kernel.org/linux-doc/20230817220957.41582-1-giulio.benetti@benettiengineering.com/ Signed-off-by: Giulio Benetti [yann.morin.1998@free.fr: - reword to reference sub-addressing and the RFC - move to the "submitting patches" section, that already deals with SoB tags - differentiate between Your/Their names ] Signed-off-by: Yann E. MORIN (cherry picked from commit de349df08c653a822166f94dbe01295a5a3cfa6e) Signed-off-by: Peter Korsgaard --- docs/manual/contribute.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt index 94f1c64496..15fe36aef0 100644 --- a/docs/manual/contribute.txt +++ b/docs/manual/contribute.txt @@ -247,6 +247,23 @@ which have the upstream license), and that you are allowed to do so. See http://developercertificate.org/[the Developer Certificate of Origin] for details. +To give credits to who sponsored the creation of a patch or the process of +upstreaming it, you may use +https://datatracker.ietf.org/doc/html/rfc5233[email subaddressing] for +your git identity (i.e. what is used as commit author and email +From:+ +field, as well as your Signed-off-by tag); add suffix to the local part, +separated from it by a plus `+` sign. E.g.: + +* for a company which sponsored the submitted work, use the company name + as the detail (suffix) part: ++ +`Your-Name Your-Surname ` + +* for an individual who sponsored who sponsored the submitted work, use + their name and surname: ++ +`Your-Name Your-Surname ` + When adding new packages, you should submit every package in a separate patch. This patch should have the update to +package/Config.in+, the package +Config.in+ file, the +.mk+ file, the