Skip to content

Commit ee3ecc7

Browse files
committed
Document how PRs and docs should be referenced in release notes
1 parent 46c917a commit ee3ecc7

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

sycl/doc/developer/ContributeToDPCPP.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,10 @@ There are no strict guidelines on how to structure release notes, but for
6060
consistency it is better to follow the existing structure minimal changes. The
6161
structure we have been using so far is split by change type (i.e. new
6262
features and bug fixes) and then sub-split by component (i.e. compiler,
63-
runtime). Please use past tense when describing your change.
63+
runtime). Please use past tense when describing your change and leave a
64+
reference to your PR using `intel/llvm#NNNNN` syntax. If you want to reference
65+
an in-tree document (like an extension spec, for example), it must be
66+
referenced using a permalink so that it stays actual even if document is moved.
6467

6568
When in doubt, you can always ask reviewers for help/guidance/suggestions.
6669

0 commit comments

Comments
 (0)