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 style is inconsistent #81

Open
Sakarah opened this issue Oct 24, 2020 · 0 comments
Open

Code style is inconsistent #81

Sakarah opened this issue Oct 24, 2020 · 0 comments

Comments

@Sakarah
Copy link
Contributor

Sakarah commented Oct 24, 2020

The whole library has a very inconsistent code style. Apart from basic naming conventions (like functions and types are CamlCase, variable lowerCamlCase and constants are UPPER_CASE), there is no format convention, pointer * are sometimes attached to the type, sometimes to the function, some code use spaces, some use tabs, some use tabs but configured to be 2 space long, etc...

I strongly suggest that a maintainer should define a convention once and for all, they are all arbitrary don't worry too much about which one, maybe just try to minimize the differences from current "average" code, configure an auto-formater such as clang-format to follow this convention and apply it everywhere, and continue applying it on every incoming pull request.

This is a minor problem but it might save time on conflict resolution, and make collaboration on the project a lot more pleasant in my opinion.

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

No branches or pull requests

1 participant