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

Coding guidelines are missing #186

Open
nhjschulz opened this issue Oct 31, 2024 · 0 comments
Open

Coding guidelines are missing #186

nhjschulz opened this issue Oct 31, 2024 · 0 comments
Assignees

Comments

@nhjschulz
Copy link
Collaborator

Issue:
The project is lacking coding guidelines, only formatting rules exist through clang-format.
"Pathfinder rule" is applied, but works well only for style formatting, not regarding langugage feature usage.

Impact:

  • Lack of rules leads to review feedback biased to personal preferences.
  • No reasoning why a construct should be used or not
  • Inconsistencies when to add/remove optional C++ syntax elements that are implicit if missing .

This impairs collaboration when the number of comitters grows.

Proposed solution:

  • Create/Link to coding guideline rules and improve them over time based on code review findings.
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

2 participants