Skip to content

Commit eb33bbc

Browse files
author
Pavel Chupin
authored
[SYCL][Doc] Add info on PR merge process (#7792)
* Add what to do with unexpected fails * Add some cross-doc links
1 parent 89e82e3 commit eb33bbc

File tree

3 files changed

+17
-1
lines changed

3 files changed

+17
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,15 @@ approved by an Intel representative.
8181
- A new approval is needed if the PR was updated (e.g. during code review).
8282
- Once the PR is approved and all checks have passed, the pull request is
8383
ready for merge.
84+
- Sometimes unrelated fails can be observed in the PR. It's author
85+
responsibility to find/guess the reason of these fails and post a comment in
86+
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
92+
open a new [issue](/../../issues)
8493
8594
### Merge
8695
@@ -89,7 +98,8 @@ and merge] and using PR description as the commit message, replacing all
8998
individual comments made per commit. Authors of the change must ensure PR
9099
description is up to date at the merge stage, as sometimes comments addressed
91100
during code reviews can invalidate original PR description. Feel free to ping
92-
@intel/llvm-gatekeepers if your PR is green and can be merged.
101+
@intel/llvm-gatekeepers if your PR is green and can be merged. Note that
102+
gatekeepers will require explanation for any failures observed.
93103
94104
Pulldown from LLVM upstream is done through merge commits to preserve hashes of
95105
the original commits pulled from the LLVM community repository.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Intel LLVM-based projects:
66
- [oneAPI DPC++ compiler](#oneapi-dpc-compiler)
77
- [Late-outline OpenMP and OpenMP Offload](#late-outline-openmp-and-openmp-offload)
88

9+
For general contribution process see [CONTRIBUTING.md](./CONTRIBUTING.md)
10+
911
## oneAPI DPC++ compiler
1012

1113
[![](https://spec.oneapi.io/oneapi-logo-white-scaled.jpg)](https://www.oneapi.io/)

sycl/doc/developer/ContributeToDPCPP.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Contributing to DPC++
22

3+
## General guidelines
4+
5+
Read [CONTRIBUTING.md](/CONTRIBUTING.md) first.
6+
37
## Maintaining stable ABI/API
48

59
All changes made to the DPC++ compiler and runtime library should generally

0 commit comments

Comments
 (0)