Skip to content

Commit ee2feb2

Browse files
authored
Merge pull request #1505 from kbenzie/benie/doc-pr-title-convention
Document PR title conventions
2 parents 6d08e9f + 605c605 commit ee2feb2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

scripts/core/CONTRIB.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,16 @@ Adapter Change Process
5656
`oneapi-src/unified-runtime`_ project targeting the `main
5757
<https://github.com/oneapi-src/unified-runtime/tree/main>`_ branch.
5858

59+
.. note::
60+
Historically, convention on the project has been to add one or more
61+
``[COMPONENT]`` prefixes to the pull request title to signify which
62+
components are changed within. This is no longer necessary as pull
63+
requests are now automatically labeled by the `Pull Request Labeler
64+
<https://github.com/oneapi-src/unified-runtime/blob/main/.github/labeler.yml>`_
65+
GitHub Action. This approach is less error prone and much easier to
66+
filter on the GitHub pull requests tab. Lastly, commit and pull request
67+
summaries should strive be short to align with Git convention.
68+
5969
2. Create a draft pull request in the `intel/llvm`_ project to take advantage
6070
of the pre-merge testing. Add any required implementation changes in
6171
addition to changing:

0 commit comments

Comments
 (0)