From 605c605393174f0f730a84aadfdf7d40eceffb5b Mon Sep 17 00:00:00 2001 From: "Kenneth Benzie (Benie)" Date: Wed, 10 Apr 2024 10:57:51 +0100 Subject: [PATCH] Document PR title conventions With the addition of the *Pull Request Labeler* job, add guidance on PR title prefixes to the contribution guide. --- scripts/core/CONTRIB.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/scripts/core/CONTRIB.rst b/scripts/core/CONTRIB.rst index 8495292d05..5499f09687 100644 --- a/scripts/core/CONTRIB.rst +++ b/scripts/core/CONTRIB.rst @@ -56,6 +56,16 @@ Adapter Change Process `oneapi-src/unified-runtime`_ project targeting the `main `_ branch. + .. note:: + Historically, convention on the project has been to add one or more + ``[COMPONENT]`` prefixes to the pull request title to signify which + components are changed within. This is no longer necessary as pull + requests are now automatically labeled by the `Pull Request Labeler + `_ + GitHub Action. This approach is less error prone and much easier to + filter on the GitHub pull requests tab. Lastly, commit and pull request + summaries should strive be short to align with Git convention. + 2. Create a draft pull request in the `intel/llvm`_ project to take advantage of the pre-merge testing. Add any required implementation changes in addition to changing: