blob: 43282721e3bb494fa1328e3a95bd23e0c99f21a0 [file] [log] [blame] [view]
Francesco Servidio5dad5b72021-11-18 16:30:26 +01001# Patch submission
David Brownf1a78fc2017-06-20 12:57:27 -06002
Francesco Servidio5dad5b72021-11-18 16:30:26 +01003The development of MCUboot takes place in the [MCUboot GitHub
4repository](https://github.com/mcu-tools/mcuboot).
David Brownf1a78fc2017-06-20 12:57:27 -06005
Francesco Servidio5dad5b72021-11-18 16:30:26 +01006To submit patches, use GitHub pull requests.
David Brownf1a78fc2017-06-20 12:57:27 -06007
Francesco Servidio5dad5b72021-11-18 16:30:26 +01008Each commit has to have, in the commit message, a "Signed-off-by" line
9that mentions the author (and the committer, if that is different). You
10must add this line at the end of the commit text, separated by a blank
11line. You can also add a line linking the commit to a specific GitHub
12issue, as this section supports multiple lines, similarly to RFC-2822.
David Brownf1a78fc2017-06-20 12:57:27 -060013
Francesco Servidio5dad5b72021-11-18 16:30:26 +010014The supported trailer lines are structured as follows:
David Brownf1a78fc2017-06-20 12:57:27 -060015
Francesco Servidio5dad5b72021-11-18 16:30:26 +010016- A line that indicates that the signer agrees to the "Developer
17Certificate of Origin" located at the bottom of this page:
David Brownf1a78fc2017-06-20 12:57:27 -060018
Francesco Servidio5dad5b72021-11-18 16:30:26 +010019 ```
20 Signed-off-by: Developer Name <devname@example.com>
21 ```
David Brownf1a78fc2017-06-20 12:57:27 -060022
Francesco Servidio5dad5b72021-11-18 16:30:26 +010023- A line that links this commit to specific GitHub issues, if present:
David Brownf1a78fc2017-06-20 12:57:27 -060024
Francesco Servidio5dad5b72021-11-18 16:30:26 +010025 ```
26 Keyword #GH_issue_number
27 ```
28
29 For more details about linking a GitHub pull request to a GitHub issue,
30 see this [link]
31 (https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
32
David Brown4337fee2023-02-14 16:54:40 -070033## Release notes
34
35To facilitate creating release notes at release time, all non-trivial
36changes must include a release note snippet in the pull request.
37This can be either a separate commit, or as part of a single commit
38(generally, if there are multiple commits to the pull request, the
39release note snippet should be a separate commit, and a pull request
40that is a single commit can include the release note snippet in that
41commit). In either case, the release notes must be included in the
42same PR that makes the given change.
43
44The release notes should be placed in the `docs/release-notes.d`
45directory. Please see the readme file in that directory for specifics.
46
Francesco Servidio5dad5b72021-11-18 16:30:26 +010047## Developer certificate of origin
48
49The following is the "Developer Certificate of Origin":
David Brownf1a78fc2017-06-20 12:57:27 -060050
51```
52Developer Certificate of Origin
53Version 1.1
54
55Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
561 Letterman Drive
57Suite D4700
58San Francisco, CA, 94129
59
60Everyone is permitted to copy and distribute verbatim copies of this
61license document, but changing it is not allowed.
62
63
64Developer's Certificate of Origin 1.1
65
66By making a contribution to this project, I certify that:
67
68(a) The contribution was created in whole or in part by me and I
69 have the right to submit it under the open source license
70 indicated in the file; or
71
72(b) The contribution is based upon previous work that, to the best
73 of my knowledge, is covered under an appropriate open source
74 license and I have the right under that license to submit that
75 work with modifications, whether created in whole or in part
76 by me, under the same open source license (unless I am
77 permitted to submit under a different license), as indicated
78 in the file; or
79
80(c) The contribution was provided directly to me by some other
81 person who certified (a), (b) or (c) and I have not modified
82 it.
83
84(d) I understand and agree that this project and the contribution
85 are public and that a record of the contribution (including all
86 personal information I submit with it, including my sign-off) is
87 maintained indefinitely and may be redistributed consistent with
88 this project or the open source license(s) involved.
89```