@@ -24,24 +24,25 @@ for more information.
2424 - For the DPC++ Compiler project, use ** sycl** branch as baseline for your
2525 changes. See [ Get Started Guide] ( sycl/doc/GetStartedGuide.md ) .
2626- Prepare your patch
27- - follow [ LLVM coding standards] ( https://llvm.org/docs/CodingStandards.html )
28- - [ clang-format] ( https://clang.llvm.org/docs/ClangFormat.html ) and
29- [ clang-tidy] ( https://clang.llvm.org/extra/clang-tidy/ ) tools can be
30- integrated into your workflow to ensure formatting and stylistic
31- compliance of your changes.
32- - use
33- ```
34- ./clang/tools/clang-format/git-clang-format `git merge-base origin/sycl HEAD`
35- ```
36- to check the format of your current changes against the `origin/sycl`
37- branch.
38- - `-f` to also correct unstaged changes
39- - `--diff` to only print the diff without applying
40- - Build the project and run all tests.
41- - complete test suite: `python buildbot/check.py`
42- - sycl test suite `python buildbot/check.py -t test-sycl`
43- - run only "mytest" test `python buildbot/check.py -t test-sycl-mytest`
44- - if necessary, use `-o $LLVM_BUILD_DIR` to specify the llvm build directory
27+ - follow [ LLVM coding standards] ( https://llvm.org/docs/CodingStandards.html )
28+ - [ clang-format] ( https://clang.llvm.org/docs/ClangFormat.html ) and
29+ [ clang-tidy] ( https://clang.llvm.org/extra/clang-tidy/ ) tools can be
30+ integrated into your workflow to ensure formatting and stylistic
31+ compliance of your changes.
32+ - use
33+
34+ ``` bash
35+ ./clang/tools/clang-format/git-clang-format ` git merge-base origin/sycl HEAD`
36+ ```
37+
38+ to check the format of your current changes against the ` origin/sycl`
39+ branch.
40+ - ` -f` to also correct unstaged changes
41+ - ` --diff` to only print the diff without applying
42+ - Build the project following
43+ [Get Started Guide instructions](sycl/doc/GetStartedGuide.md#build-dpc-toolchain).
44+ - Run regression tests -
45+ [instructions](sycl/doc/GetStartedGuide.md#test-dpc-toolchain).
4546
4647# ## Commit message
4748
@@ -67,6 +68,7 @@ ready for merge.
6768# ## Merge
6869
6970Project maintainers merge pull requests using one of the following options:
71+
7072- [Rebase and merge] The preferable choice for PRs containing a single commit
7173- [Squash and merge] Used when there are multiple commits in the PR
7274 - Squashing is done to make sure that the project is buildable on any commit
0 commit comments