Skip to content

Commit 2f5cd28

Browse files
author
Artem Gindinson
authored
[SYCL][Doc] Improve contribution guidelines (#1422)
- Commit message requirements were added; - clang-format/clang-tidy usage became explicitly recommended; - Some stylistic issues were addressed (grammar, missing dots, etc.) Signed-off-by: Artem Gindinson <artem.gindinson@intel.com>
1 parent 4a341e1 commit 2f5cd28

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,23 +69,41 @@ commit automatically with `git commit -s`.
6969

7070
### Development
7171

72+
**NB**: For any changes not related to DPC++, but rather to LLVM in general, it
73+
is strongly encouraged that you submit the patch to https://llvm.org/ directly.
74+
See [LLVM contribution guidelines](https://llvm.org/docs/Contributing.html)
75+
for more information.
76+
7277
- Create a personal fork of the project on GitHub
7378
- For the DPC++ Compiler project, use **sycl** branch as baseline for your
7479
changes. See [Get Started Guide](sycl/doc/GetStartedGuide.md).
7580
- Prepare your patch (follow
76-
[LLVM coding standards](https://llvm.org/docs/CodingStandards.html))
77-
- Build the project and run all tests
81+
[LLVM coding standards](https://llvm.org/docs/CodingStandards.html)).
82+
[clang-format](https://clang.llvm.org/docs/ClangFormat.html) and [clang-tidy](
83+
https://clang.llvm.org/extra/clang-tidy/) tools can be integrated into your
84+
workflow to ensure formatting and stylistic compliance of your changes.
85+
- Build the project and run all tests.
86+
87+
### Commit message
88+
89+
- When writing your commit message, please make sure to follow
90+
[LLVM developer policies](
91+
https://llvm.org/docs/DeveloperPolicy.html#commit-messages) on the subject.
92+
- For any DPC++-related commit, the `[SYCL]` tag should be present in the
93+
commit message title. To a reasonable extent, additional tags can be used
94+
to signify the component changed, e.g.: `[PI]`, `[CUDA]`, `[Doc]`.
7895

7996
### Review and acceptance testing
8097

8198
- Create a pull request for your changes following [Creating a pull request
82-
instructions](https://help.github.com/articles/creating-a-pull-request/)
83-
- CI will run signed-off check as soon as PR is created, see **check_pr** CI
84-
check for results
85-
- CI will run build and functional testing check as soon as PR is approved by
86-
Intel representative
87-
- New approval is needed if PR was updated (e.g. during code review)
88-
- Once PR is approved and all checks pass, the pull request is ready for merge
99+
instructions](https://help.github.com/articles/creating-a-pull-request/).
100+
- CI will run a signed-off check as soon as your PR is created - see the
101+
**check_pr** CI action results.
102+
- CI will run several build and functional testing checks as soon as the PR is
103+
approved by an Intel representative.
104+
- A new approval is needed if the PR was updated (e.g. during code review).
105+
- Once the PR is approved and all checks have passed, the pull request is
106+
ready for merge.
89107

90108
### Merge
91109

@@ -98,4 +116,3 @@ commits pulled from the LLVM community repository
98116

99117

100118
*Other names and brands may be claimed as the property of others.
101-

0 commit comments

Comments
 (0)