-
Notifications
You must be signed in to change notification settings - Fork 15.5k
[SYCL] Add CodingGuidelines.rst for libsycl #171867
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.
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
base: main
Are you sure you want to change the base?
[SYCL] Add CodingGuidelines.rst for libsycl #171867
Conversation
Signed-off-by: Tikhomirova, Kseniya <kseniya.tikhomirova@intel.com>
|
some extra details can be found here #166927 (comment) |
| classes for LIT tests and that should be excluded from test descovery. | ||
|
|
||
| * **File Names in snake case** should be used for all C++ implementation files. | ||
| For example files in folders ``include``, ``src``, ``test``, ``utils``, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
test is an umbrella for all types of tests here. I expect test_e2e and unittests follow the same rule.
| Introduction | ||
| ============ | ||
|
|
||
| In general ``libsycl`` project adopts LLVM Coding Standards. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A link to LLVM Coding Standards would be helpful here I think to ease user's navigation.
| * **Other types (implementation details)** should follow LLVM Coding Standards | ||
| and should be declared in camel case. | ||
|
|
||
| Name of Files and Folders |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please, use term "directory" instead of "folder".
No description provided.