Skip to content

Commit

Permalink
[SYCL][Doc] Add info on PR merge process (intel#7792)
Browse files Browse the repository at this point in the history
* Add what to do with unexpected fails
* Add some cross-doc links
  • Loading branch information
Pavel Chupin authored Dec 16, 2022
1 parent 89e82e3 commit eb33bbc
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,15 @@ approved by an Intel representative.
- A new approval is needed if the PR was updated (e.g. during code review).
- Once the PR is approved and all checks have passed, the pull request is
ready for merge.
- Sometimes unrelated fails can be observed in the PR. It's author
responsibility to find/guess the reason of these fails and post a comment in
the PR with:
- possible reason of fails, ideally with a link to the PR, which caused fails
- link to other PR(s), which expected to fix fails
- person who is currently looking into fails
- link to existing open issue
- if author cannot identify any of these, the minimal action expected is to
open a new [issue](/../../issues)
### Merge
Expand All @@ -89,7 +98,8 @@ and merge] and using PR description as the commit message, replacing all
individual comments made per commit. Authors of the change must ensure PR
description is up to date at the merge stage, as sometimes comments addressed
during code reviews can invalidate original PR description. Feel free to ping
@intel/llvm-gatekeepers if your PR is green and can be merged.
@intel/llvm-gatekeepers if your PR is green and can be merged. Note that
gatekeepers will require explanation for any failures observed.
Pulldown from LLVM upstream is done through merge commits to preserve hashes of
the original commits pulled from the LLVM community repository.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Intel LLVM-based projects:
- [oneAPI DPC++ compiler](#oneapi-dpc-compiler)
- [Late-outline OpenMP and OpenMP Offload](#late-outline-openmp-and-openmp-offload)

For general contribution process see [CONTRIBUTING.md](./CONTRIBUTING.md)

## oneAPI DPC++ compiler

[![](https://spec.oneapi.io/oneapi-logo-white-scaled.jpg)](https://www.oneapi.io/)
Expand Down
4 changes: 4 additions & 0 deletions sycl/doc/developer/ContributeToDPCPP.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Contributing to DPC++

## General guidelines

Read [CONTRIBUTING.md](/CONTRIBUTING.md) first.

## Maintaining stable ABI/API

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

0 comments on commit eb33bbc

Please sign in to comment.