[SYCL] Add CodingGuidelines.rst for libsycl#171867
Merged
Conversation
Signed-off-by: Tikhomirova, Kseniya <kseniya.tikhomirova@intel.com>
Contributor
Author
|
some extra details can be found here #166927 (comment) |
bader
changed the title
dvrogozh
reviewed
Dec 15, 2025
bader
approved these changes
Dec 17, 2025
Signed-off-by: Tikhomirova, Kseniya <kseniya.tikhomirova@intel.com>
tahonermann
requested changes
Jan 12, 2026
Contributor
tahonermann
left a comment
tahonermann
left a comment
There was a problem hiding this comment.
Sorry for the long delay on this, @KseniyaTikhomirova. I posted a number of suggestions intended to simplify and shorten the document and to address grammar and spelling issues.
libsycl/docs/CodingGuidelines.rst
Outdated
Comment on lines
41
to
44
| * **Directory Names** within ``libsycl`` directory should be in the snake case | ||
| (e.g. ``test_e2e``). In some case exceptions may apply: for example | ||
| ``Inputs`` is usually used as default name for directories, containing helper | ||
| classes for LIT tests and that should be excluded from test descovery. |
Contributor
There was a problem hiding this comment.
Suggested change
| * **Directory Names** within ``libsycl`` directory should be in the snake case | |
| (e.g. ``test_e2e``). In some case exceptions may apply: for example | |
| ``Inputs`` is usually used as default name for directories, containing helper | |
| classes for LIT tests and that should be excluded from test descovery. | |
| * **Directory Names** should be in snake case (e.g. ``test_e2e``) except in | |
| cases where LLVM project wide conventions are used. For example, LIT tests | |
| often use an ``Inputs`` directory to hold files that are used by tests but | |
| that should be excluded from test discovery. |
Signed-off-by: Tikhomirova, Kseniya <kseniya.tikhomirova@intel.com>
Contributor
Author
|
@tahonermann thank you, I agree with all your comments and applied them all af2ecc6 |
tahonermann
approved these changes
Jan 14, 2026
Contributor
tahonermann
left a comment
tahonermann
left a comment
There was a problem hiding this comment.
Thanks, @KseniyaTikhomirova!
Priyanshu3820
pushed a commit
to Priyanshu3820/llvm-project
that referenced
this pull request
Jan 18, 2026
Signed-off-by: Tikhomirova, Kseniya <kseniya.tikhomirova@intel.com>
BStott6
pushed a commit
to BStott6/llvm-project
that referenced
this pull request
Jan 22, 2026
Signed-off-by: Tikhomirova, Kseniya <kseniya.tikhomirova@intel.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.