Skip to content
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

clang-format #172

Merged
merged 6 commits into from
May 18, 2020
Merged

clang-format #172

merged 6 commits into from
May 18, 2020

Conversation

bernhardmgruber
Copy link
Member

@psychocoderHPC
Copy link
Member

We need to document in the readme or contribution the command you need to use to format all files.

@bernhardmgruber
Copy link
Member Author

Shouldn't that be obvious by the existance of the .clang-format file?

Otherwise, what would you prefer? Creating a new contributing.md, add it to readme.md, where there is no developer related content, or install.md where the build instructions are?

As for the command, that depends a lot on what shell and operating system you use. I think a developer should find this information for themselves on the web.

@psychocoderHPC
Copy link
Member

Shouldn't that be obvious by the existence of the .clang-format file?

No it is not because the command is not simply clang-format, do not assume that someone knows a special tool.

Otherwise, what would you prefer? Creating a new contributing.md, add it to readme.md, where there is no developer related content, or install.md where the build instructions are?

I see we do not have such a file, so I suggest to create it and link it in README.md too.

As for the command, that depends a lot on what shell and operating system you use.

You can provide it for linux and windows. MAC should be equal to windows.

I think a developer should find this information for themselves on the web.

You can provide a link to the documentation but give them a copy past line too.

@bernhardmgruber
Copy link
Member Author

I added a CONTRIBUTING.md and described briefly how to format.

@bernhardmgruber bernhardmgruber mentioned this pull request May 14, 2020
1 task
@psychocoderHPC
Copy link
Member

Note: We will take this code style for now. It could be we need to update this file again after we agreed for a common style file in ComputationalRadiationPhysics/contributing#33

@psychocoderHPC psychocoderHPC merged commit 7a3d1ce into alpaka-group:dev May 18, 2020
@bernhardmgruber bernhardmgruber deleted the format branch May 18, 2020 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants