Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 1 | # Patch submission |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 2 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 3 | The development of MCUboot takes place in the [MCUboot GitHub |
| 4 | repository](https://github.com/mcu-tools/mcuboot). |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 5 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 6 | To submit patches, use GitHub pull requests. |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 7 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 8 | Each commit has to have, in the commit message, a "Signed-off-by" line |
| 9 | that mentions the author (and the committer, if that is different). You |
| 10 | must add this line at the end of the commit text, separated by a blank |
| 11 | line. You can also add a line linking the commit to a specific GitHub |
| 12 | issue, as this section supports multiple lines, similarly to RFC-2822. |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 13 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 14 | The supported trailer lines are structured as follows: |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 15 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 16 | - A line that indicates that the signer agrees to the "Developer |
| 17 | Certificate of Origin" located at the bottom of this page: |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 18 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 19 | ``` |
| 20 | Signed-off-by: Developer Name <devname@example.com> |
| 21 | ``` |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 22 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 23 | - A line that links this commit to specific GitHub issues, if present: |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 24 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 25 | ``` |
| 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 Brown | 4337fee | 2023-02-14 16:54:40 -0700 | [diff] [blame] | 33 | ## Release notes |
| 34 | |
| 35 | To facilitate creating release notes at release time, all non-trivial |
| 36 | changes must include a release note snippet in the pull request. |
| 37 | This 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 |
| 39 | release note snippet should be a separate commit, and a pull request |
| 40 | that is a single commit can include the release note snippet in that |
| 41 | commit). In either case, the release notes must be included in the |
| 42 | same PR that makes the given change. |
| 43 | |
| 44 | The release notes should be placed in the `docs/release-notes.d` |
| 45 | directory. Please see the readme file in that directory for specifics. |
| 46 | |
Francesco Servidio | 5dad5b7 | 2021-11-18 16:30:26 +0100 | [diff] [blame] | 47 | ## Developer certificate of origin |
| 48 | |
| 49 | The following is the "Developer Certificate of Origin": |
David Brown | f1a78fc | 2017-06-20 12:57:27 -0600 | [diff] [blame] | 50 | |
| 51 | ``` |
| 52 | Developer Certificate of Origin |
| 53 | Version 1.1 |
| 54 | |
| 55 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 56 | 1 Letterman Drive |
| 57 | Suite D4700 |
| 58 | San Francisco, CA, 94129 |
| 59 | |
| 60 | Everyone is permitted to copy and distribute verbatim copies of this |
| 61 | license document, but changing it is not allowed. |
| 62 | |
| 63 | |
| 64 | Developer's Certificate of Origin 1.1 |
| 65 | |
| 66 | By 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 | ``` |