Add .clang-format config, provide to super-linter, and apply formatting to codebase #439
Conversation
.clang-format configuration file added to allow standardisation of formatting across the repository. The configuration was obtained from PyTorch. The PyTorch license file is included as a comment in the file, to ensure copyright holders are given attribution.
Updating super-linter gives a significantly newer version of clang-format (17.0.6 -> 19.1.4). Linking .clang-format to .github/config/lint/.clang-format allows super-linter to use the configured rules for linting.
This commit extends the work done in 55b6bf7. clang-format (version 19.1.7) is applied to the whole Gloo codebase. The config used is the .clang-format file provided in the previous commit, so that a consistent format can be used for all contributors going forward.
What does this mean, compared to the existing super-linter job? |
|
@jackbondpreston-arm Doesn't seem like the super-linter CI job is running? Need to follow up on that |
Yes, I imagine it was disabled due to it previously not having any So, I think we should be good to re-enable the |
|
Looks like it's working in #445 |
55b6bf7 applied clang-format to the codebase, but did not add the configuration file used. This change adds the configuration file,
.clang-format, and applies clang-format to the codebase. The configuration file is imported from PyTorch, with attribution in comments at the beginning of the file.The config file used seems to line up well with the one used for 55b6bf7, as the diff generated is relatively small. Having the config available will enable contributions going forward to use consistent formatting and avoid having to apply it across the whole codebase again.
To further this aim, I have linked the
.clang-formatinto.github/config/lint, to enable thelintjob in CI to utilise it for formatting checking. Additionally, I have updated the version ofsuper-linterused in this job to a newer one, as this provides a much newer version ofclang-format.I have verified the super-linter job locally, using act, and have confirmed it seems to be working fine. For this reason, I suggest that we can re-enable the linting job in CI, to ensure contributions now follow the
.clang-format.The benefit to this project is that we can have a consistent and clear formatting style, saving time for developers and reviewers by avoiding having to think/argue about formatting - it can simply be applied with a standard tool.