KhronosGroup / KhronosGroup/Vulkan-Hpp
Set up CI and pre-commit hooks for `clang-format`
- Dominant language
- C++
- Stars
- 3.8k
- Forks
- 374
- Avg merge
- 23h 4m
- Merged PRs (30d)
- 32
Description
Essentially the title. For example, the LLVM project has [a CI workflow](https://github.com/llvm/llvm-project/blob/main/.github/workflows/pr-code-format.yml) that checks if the PR is correctly formatted, and what fix to apply. I understand `git clang-format` is also a supported subcommand of git, so we could find some ways to prevent badly-formatted code from even being committed, let alone pushed.
Contributor guide
Research direction
Start by reviewing the LLVM example at .github/workflows/pr-code-format.yml and the repository's existing CI configuration. Investigate how git clang-format can support a pre-commit check, then define CI and hook behavior that identifies formatting problems and shows the applicable fix; done means both checks are set up and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, git, github-actions
- Domain
- build-system, ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100