Skip to content

Commit 4d0cc78

Browse files
authored
Clarify requirements for downstream changes (#599)
Make it clearer why the issue should exist, what it needs to be updated with, and when it can be closed.
1 parent 6d78ec4 commit 4d0cc78

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,21 @@ requirements below:
165165
of why the patch isn't being made upstream. This should include
166166
links to any previous attempts to upstream.
167167

168+
* An issue must be opened to track the downstream change, including why it
169+
must be made downstream, and linking to any attempts to make the change
170+
upstream. This issue should then be updated with any progress on
171+
upstreaming, as well as the on-going maintenance of the change downstream,
172+
such as updates or merge conflicts. The issue can be closed when the change
173+
is removed, or when the branch the change exists on is no longer active and
174+
the change no longer requires maintaining.
175+
168176
* The commit message for a new downstream patch must include
169-
`Downstream issue:#<issue number>` where `#<issue number>` is an issue
170-
that contains the reason for the downstream patch,
171-
for example `Downstream issue:#123`. A space is allowed before the `#<issue number>`.
177+
`Downstream issue:#<issue number>` on its own line, where `#<issue number>`
178+
is the issue created above, for example `Downstream issue:#123`. Some
179+
tolerance is allowed for whitespace, so `Downstream issue: #123` will also
180+
work, but using a link of `arm/arm-toolchain#123` will not, even if this
181+
displays as `#123` in the UI. Any commits modifying the downstream change
182+
will also need this line.
172183

173184
* The source change should be annotated with a comment including the
174185
`#<issue number>`, if there are multiple lines changed a single

0 commit comments

Comments
 (0)