search

gyunaev / karlyriceditor

lyrics editor and CD+G/video exporter for Karaoke
http://www.ulduzsoft.com/linux/karaoke-lyrics-editor/
GNU General Public License v3.0
57 stars 16 forks source link

Code formatting with clang-format #28

Open dwRchyngqxs opened 2 months ago

dwRchyngqxs commented 2 months ago

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.

dwRchyngqxs commented 2 months ago

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.