Skip to content

Commit 8cf5033

Browse files
authored
[DOC] Update section on new contributing and new CI flow process and other small edits (#10749)
The CI system no longer auto runs pre-commit activities for new contributors by default. Update the documentation to reflect the new process of needing someone to approve workload run. Also, since i'm here, make some small constancy edits in some files I was touching.
1 parent b9c8516 commit 8cf5033

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ To contribute:
2828

2929
- Create a personal fork of the project on GitHub
3030
- Prepare your patch
31-
- follow [LLVM coding standards](https://llvm.org/docs/CodingStandards.html)
32-
- [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and
31+
- Follow [LLVM coding standards](https://llvm.org/docs/CodingStandards.html)
32+
- [Clang-format](https://clang.llvm.org/docs/ClangFormat.html) and
3333
[clang-tidy](https://clang.llvm.org/extra/clang-tidy/) tools can be
3434
integrated into your workflow to ensure formatting and stylistic
3535
compliance of your changes. To avoid code formatting misalignment with
3636
GitHub Actions check we recommend using 10 version of clang-format tool
3737
(default version on Ubuntu 22.04).
38-
- use
38+
- Use
3939

4040
```bash
4141
./clang/tools/clang-format/git-clang-format `git merge-base origin/sycl HEAD`
@@ -78,19 +78,25 @@ To contribute:
7878

7979
- CI will run several build and functional testing checks as soon as the PR is
8080
approved by an Intel representative.
81+
- By default, pre-commit activies (build/test) will not auto start when PR
82+
is submitted for new contributors and non members of the project. If your
83+
PR shows "workflow awaiting approval" then your assigned code reviewer or
84+
another member of the project will need to approve the test run and start
85+
it for you. If you are unable to reach someone to approve your run, please
86+
contact the project gatekeepers (@intel/llvm-gatekeepers).
8187
- A new approval is needed if the PR was updated (e.g. during code review).
8288
- Once the PR is approved and all checks have passed, the pull request is
8389
ready for merge.
8490
- Sometimes unrelated fails can be observed in the PR. It's author
8591
responsibility to find/guess the reason of these fails and post a comment in
8692
the PR with:
87-
- possible reason of fails, ideally with a link to the PR, which caused fails
88-
- link to other PR(s), which expected to fix fails
89-
- person who is currently looking into fails
90-
- link to existing open issue
91-
- if author cannot identify any of these, the minimal action expected is to
93+
- Possible reason of fails, ideally with a link to the PR, which caused fails
94+
- Link to other PR(s), which expected to fix fails
95+
- Person who is currently looking into fails
96+
- Link to existing open issue
97+
- If author cannot identify any of these, the minimal action expected is to
9298
open a new [issue](/../../issues)
93-
- list of unrelated tests failing in pre-commit CI. This would enable easy
99+
- List of unrelated tests failing in pre-commit CI. This would enable easy
94100
access to them via github search functionality.
95101
96102
### Merge

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@ Submit an [issue](https://github.com/intel/llvm/issues) or initiate a
7474

7575
### How to contribute to DPC++
7676

77-
See [ContributeToDPCPP](./sycl/doc/developer/ContributeToDPCPP.md).
77+
This project welcomes contributions from the community. Please refer to [CONTRIBUTING](/CONTRIBUTING.md)
78+
for general guidelines around contributing to this project. You can then see
79+
[ContributeToDPCPP](./sycl/doc/developer/ContributeToDPCPP.md) for DPC++ specific
80+
guidelines.
7881

7982
## Late-outline OpenMP\* and OpenMP\* Offload
8083

0 commit comments

Comments
 (0)