Skip to content

Commit e52f198

Browse files
committed
[SYCL][Doc] Improve contribution guidelines
- 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 886194d commit e52f198

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,19 +73,32 @@ commit automatically with `git commit -s`.
7373
- For the DPC++ Compiler project, use **sycl** branch as baseline for your
7474
changes. See [Get Started Guide](sycl/doc/GetStartedGuide.md).
7575
- Prepare your patch (follow
76-
[LLVM coding standards](https://llvm.org/docs/CodingStandards.html))
77-
- Build the project and run all tests
76+
[LLVM coding standards](https://llvm.org/docs/CodingStandards.html)).
77+
[clang-format](https://clang.llvm.org/docs/ClangFormat.html) and [clang-tidy](
78+
https://clang.llvm.org/extra/clang-tidy/) tools can be integrated into your
79+
workflow to ensure formatting and stylistic compliance of your changes.
80+
- Build the project and run all tests.
81+
82+
### Commit message
83+
84+
- When writing your commit message, please make sure to follow
85+
[LLVM developer policies](
86+
https://llvm.org/docs/DeveloperPolicy.html#commit-messages) on the subject.
87+
- For any DPC++-related commit\**, the `[SYCL]` tag should be present in the
88+
commit message title. To a reasonable extent, additional tags can be used
89+
to signify the component changed, e.g.: `[PI]`, `[CUDA]`, `[Doc]`.
7890

7991
### Review and acceptance testing
8092

8193
- 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
94+
instructions](https://help.github.com/articles/creating-a-pull-request/).
95+
- CI will run a signed-off check as soon as your PR is created - see the
96+
**check_pr** CI action results.
97+
- CI will run several build and functional testing checks as soon as the PR is
98+
approved by an Intel representative.
99+
- A new approval is needed if the PR was updated (e.g. during code review).
100+
- Once the PR is approved and all checks have passed, the pull request is
101+
ready for merge.
89102

90103
### Merge
91104

@@ -99,3 +112,7 @@ commits pulled from the LLVM community repository
99112

100113
*Other names and brands may be claimed as the property of others.
101114

115+
**For any commit not related to DPC++, but rather to LLVM in general, it is
116+
strongly encouraged that you submit the patch to https://llvm.org/ directly.
117+
See [LLVM contribution guidelines](https://llvm.org/docs/Contributing.html)
118+
for more information.

0 commit comments

Comments
 (0)