Skip to content

Commit e4adb91

Browse files
authored
Fix formatting and clarify marking of downstream changes (#377)
Angle brackets without code block in markdown should be encoded as < and >. The text in between them was missing from the rendered HTML page and looked incomplete.
1 parent da13a85 commit e4adb91

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -166,16 +166,17 @@ requirements below:
166166
links to any previous attempts to upstream.
167167

168168
* 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.
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>`.
171172

172173
* The source change should be annotated with a comment including the
173-
#<issue number>, if there are multiple lines changed a single
174+
`#<issue number>`, if there are multiple lines changed a single
174175
comment for the block can be used.
175176

176177
* The commit message that removes an existing downstream patch, such
177-
as when the upstream equivalent lands, must include Removes
178-
downstream issue:#<issue number>.
178+
as when the upstream equivalent lands, must include `Removes
179+
downstream issue:#<issue number>`.
179180

180181
* New files in the *arm-toolchain* repository must include the LLVM
181182
license, with the standard header comment and SPDX identifier.

0 commit comments

Comments
 (0)