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

Code formatting with clang-format #28

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dwRchyngqxs
Copy link

I noticed that code style is inconsistent and some questionable practices are in place (aligning fields with tabs is a no no as not every text editor uses the same tab length).
Fixing it all manually is a time consuming and needlessly tedious task. I propose the use of a code formatter to keep the style consistent.
I chose the clang-format style "Microsoft" as it seems the closest to what is in the code-base.
Maybe clang-format is not the best tool. According to the Qt doc it is one of the tools proposed by the Qt editor so I though it would be a good candidate.

Tell me what you think of this.

Copy link
Owner

@gyunaev gyunaev left a comment

Choose a reason for hiding this comment

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

You can add .clang-format but generally I don't like the huge changes which just do the formatting.

@dwRchyngqxs
Copy link
Author

dwRchyngqxs commented Aug 31, 2024

Yeah, it's almost impossible to make sure nothing was sneaked in these huge commits. Could either be done by a trusted maintainer or a bot (I don't think you're using bots though).
Then adding a CONTRIBUTING.md with code guidelines and/or a pre-merge github action that applies the formatting will help to stay style consistent.

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