Skip to content

clang-format in CI#116

Draft
alan-george-lk wants to merge 6 commits intomainfrom
feature/clang-format
Draft

clang-format in CI#116
alan-george-lk wants to merge 6 commits intomainfrom
feature/clang-format

Conversation

@alan-george-lk
Copy link
Copy Markdown
Contributor

No description provided.

Copy link
Copy Markdown
Contributor

@stephen-derosa stephen-derosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just doc-ing to ensure its tracked, need to update:

  • AGENTS.md: Use clang formatting that aligns with the existing codebase.
  • README.md: clang-format: (coming soon) code formatting and style consistency

Comment thread scripts/clang-format.sh
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to support a windows version of this?

Copy link
Copy Markdown
Contributor Author

@alan-george-lk alan-george-lk May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now we caveat in the read me that clang tools are just on Mac/Linux, I think clang-format does work on Windows since it doesn't depend on compile_commands.json, and this check would be a blocker for any Windows developers. What I don't want to do is duplicate/maintain the clang-format.sh script for a niche use case (windows based contributions). I think user on Windows could just run clang-format.exe <path to offending files> and wouldn't need the script (which is more convenient for us).

How do you feel about not duplicating the script and just adding a blurb to the readme saying you're on your own to run it? CI will still flag the offending files

Comment thread src/video_frame.cpp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants