Skip to content

Consider enforcing a consistent coding style and naming convention #169

Open

Description

@robinkrahl

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?

Activity

  1. added this to the v3.6 milestone on Jan 13, 2020
  2. szszszsz commented on Jan 13, 2020

    @szszszsz
    Collaborator

    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.

  3. robinkrahl commented on Jan 13, 2020

    @robinkrahl
    ContributorAuthor
  4. robinkrahl commented on Mar 31, 2020

    @robinkrahl
    ContributorAuthor

    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.

  5. szszszsz commented on Apr 2, 2020

    @szszszsz
    Collaborator

    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.

  6. added a commit that references this issue on Feb 14, 2022
  7. modified the milestones: v3.7, v3.8 on Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions