Skip to content

[SYCL][Doc] Improve contribution guidelines #1422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 31, 2020
Merged

[SYCL][Doc] Improve contribution guidelines #1422

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e52f198
[SYCL][Doc] Improve contribution guidelines
AGindinson Mar 28, 2020
6f93b54
Move the recommendation on LLORG vs DPC++ patches
Mar 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,23 +69,41 @@ commit automatically with `git commit -s`.

### Development

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

- Create a personal fork of the project on GitHub
- For the DPC++ Compiler project, use **sycl** branch as baseline for your
changes. See [Get Started Guide](sycl/doc/GetStartedGuide.md).
- Prepare your patch (follow
[LLVM coding standards](https://llvm.org/docs/CodingStandards.html))
- Build the project and run all tests
[LLVM coding standards](https://llvm.org/docs/CodingStandards.html)).
[clang-format](https://clang.llvm.org/docs/ClangFormat.html) and [clang-tidy](
https://clang.llvm.org/extra/clang-tidy/) tools can be integrated into your
workflow to ensure formatting and stylistic compliance of your changes.
- Build the project and run all tests.

### Commit message

- When writing your commit message, please make sure to follow
[LLVM developer policies](
https://llvm.org/docs/DeveloperPolicy.html#commit-messages) on the subject.
- For any DPC++-related commit, the `[SYCL]` tag should be present in the
commit message title. To a reasonable extent, additional tags can be used
to signify the component changed, e.g.: `[PI]`, `[CUDA]`, `[Doc]`.

### Review and acceptance testing

- Create a pull request for your changes following [Creating a pull request
instructions](https://help.github.com/articles/creating-a-pull-request/)
- CI will run signed-off check as soon as PR is created, see **check_pr** CI
check for results
- CI will run build and functional testing check as soon as PR is approved by
Intel representative
- New approval is needed if PR was updated (e.g. during code review)
- Once PR is approved and all checks pass, the pull request is ready for merge
instructions](https://help.github.com/articles/creating-a-pull-request/).
- CI will run a signed-off check as soon as your PR is created - see the
**check_pr** CI action results.
- CI will run several build and functional testing checks as soon as the PR is
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.

### Merge

Expand All @@ -98,4 +116,3 @@ commits pulled from the LLVM community repository


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