search

Nitrokey / libnitrokey

Communicate with Nitrokey devices in a clean and easy manner
https://nitrokey.com/
GNU Lesser General Public License v3.0
65 stars 34 forks source link

Consider enforcing a consistent coding style and naming convention #169

Open robinkrahl opened 4 years ago

robinkrahl commented 4 years ago

Currently, the coding style in the C++ and C source code is often inconsistent (indentation, spacing, brace placement, …). Sometimes this makes it hard to read the code. Would you consider defining a consistent coding style and using a tool like clang-format to enforce it?

Also, most files use the cc extension, except DeviceCommunicationExceptions.cpp. Some files use camel case (NitrokeyManager.cc) and some only lower case (device.cc). Would you agree to a consistent naming scheme?

szszszsz commented 4 years ago

Hi! Of course! Sorry for that. I plan large refactoring/clean up (this/next month), including code reformat, which hopefully will decrease the confusion here.

Back then I was avoiding code whitespace reformat to keep the ability of clean patches revert, and easy to find sources of the changes. Now I plan to add a style check as a part of CI and git hooks, which would prevent such issues.

robinkrahl commented 4 years ago

Nice, I’m looking forward to that! Thanks!

robinkrahl commented 4 years ago

I plan large refactoring/clean up (this/next month), including code reformat, which hopefully will decrease the confusion here.

Do you have an update on this? I have some patches I’d like to submit, but I think it would be better to wait for the refactoring.

szszszsz commented 4 years ago

Hi! Sorry for the delay. Feel free to submit the patches, I will handle them on refactoring without a problem. I think this is best option, so I will not hold you back with the nitrocli development.