Skip to content

Commit 2397fdf

Browse files
committed
[SYCL][Doc] Clean up contribution guide
- Limit lines to 80 characters - Make links to the repo files relative - Remove outdated information Signed-off-by: Alexey Bader <[email protected]>
1 parent 97a199f commit 2397fdf

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
## License
44
Intel Project for LLVM* technology is licensed under the terms of the
5-
Apache-2.0 with LLVM-exception license (
6-
[LICENSE.txt](https://github.com/intel/llvm/blob/intel/llvm/LICENSE.TXT))
5+
Apache-2.0 with LLVM-exception license ([LICENSE.txt](llvm/LICENSE.TXT))
76
to ensure our ability to contribute this project to the LLVM project
87
under the same license.
98

@@ -63,32 +62,38 @@ Then you just add a line to every git commit message:
6362

6463
Use your real name (sorry, no pseudonyms or anonymous contributions.)
6564

66-
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.
65+
If you set your `user.name` and `user.email` git configs, you can sign your
66+
commit automatically with `git commit -s`.
6767

6868
## Contribution process
6969

7070
### Development
7171

72-
- Create a personal fork of the project on GitHub.
73-
- Use **sycl** branch as baseline for your changes.
74-
- Prepare your patch (follow [LLVM coding standards](https://llvm.org/docs/CodingStandards.html)).
75-
- Build the project and run all tests (see [GetStartedWithSYCLCompiler.md](https://github.com/intel/llvm/blob/sycl/sycl/doc/GetStartedWithSYCLCompiler.md))
72+
- Create a personal fork of the project on GitHub
73+
- Use **sycl** branch as baseline for your changes
74+
- Prepare your patch (follow
75+
[LLVM coding standards](https://llvm.org/docs/CodingStandards.html))
76+
- Build the project and run all tests (see
77+
[GetStartedWithSYCLCompiler.md](sycl/doc/GetStartedWithSYCLCompiler.md))
7678

7779
### Review and acceptance testing
7880

79-
- Create a pull request for your changes following [Creating a pull request instructions](https://help.github.com/articles/creating-a-pull-request/).
80-
- When the pull request is created signed-off check is done.
81-
- **check_pr** - verifies that the signed-off mark is added to each commit message.
82-
- Once the pull request is approved by an Intel representative, build and functional testing are started.
83-
- **sycl-ubu-x64-pr** - runs all LIT tests on machine with OpenCL runtimes for CPU and GPU.
84-
- Approval is lost once the PR branch is updated. New approval and checks rerun are required.
85-
- Once approval is received and all checks pass, the pull request is ready to be merged.
81+
- Create a pull request for your changes following [Creating a pull request
82+
instructions](https://help.github.com/articles/creating-a-pull-request/)
83+
- When the pull request is created signed-off check is done
84+
- **check_pr** - verifies that the signed-off mark is added to each commit
85+
message
86+
- Once the pull request is approved by an Intel representative, build and
87+
functional testing are done
88+
- Approval is reset once the PR branch is updated
89+
- New approval and checks rerun are required
90+
- Once PR is approved and all checks pass, the pull request is ready for merge
8691

8792
### Merge
8893

89-
Merge of pull request is done only by project maintainers. There are three options:
90-
- [Rebase and merge] The preferable choice for PRs containing a single commit.
91-
- [Squash and merge] Used when there are multiple commits in the PR.
92-
Squashing is done to shorten history and make sure that the project is buildable on any commit.
93-
- [Create a merge commit] Used for pull down PRs to avoid duplication of
94-
LLVM commits.
94+
Project maintainers merge pull requests using one of the following options:
95+
- [Rebase and merge] The preferable choice for PRs containing a single commit
96+
- [Squash and merge] Used when there are multiple commits in the PR
97+
- Squashing is done make sure that the project is buildable on any commit
98+
- [Create a merge commit] Used for LLVM pull-down PRs to preserve hashes of the
99+
commits pulled from the LLVM community repository

0 commit comments

Comments
 (0)