leducp / leducp/KickCAT

[Formatting] automatic C++ code formatting

Open Beginner friendly
#377 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
170
Forks
39
PR merge metrics
No merged PRs in 30d

Description

Hi,

Thank you for creating this project!

Would it be an option to apply something like clang-format to the C++ code? I saw that the python code is formatted already using ruff, but the C++ codebase has no autoformatter configuration file. Can this be added? It can also be enforced with a github action. This would help contributions to be in correct style.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the C++ codebase and the existing Ruff formatting setup first, then check whether repository workflows already define GitHub Actions conventions. Add a clang-format configuration and a formatting check for C++ changes; done means the configuration is present and the action can verify the code style consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, github-actions
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
63/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.