man-group / ArcticDB

ArcticDB is a high performance, serverless DataFrame database built for the Python Data Science ecosystem.
http://arcticdb.io
Other
1.51k stars 93 forks source link

Enforcing a consistent coding style for the project #1565

Open G-D-Petrov opened 6 months ago

G-D-Petrov commented 6 months ago

Is your feature request related to a problem? Please describe. At the moment, the coding style is inconsistent (especially in the C++ layer), we should agree to a style and make sure to stick to it with automated tools (e.g. automated linting in the editor, git hooks, CI tooling, etc.)

Describe the solution you'd like This will be addressed in multiple stages:

G-D-Petrov commented 6 months ago

As we discussed today, I made some quick research about the C++ styling. I think that the closest style guide from the major ones is the Google one. In general, .clang-format seems like a good way to enforce the whichever style we choose on any IDE (e.g. VSCode, Clion, etc) - I tested that both VSCode and CLion produce the same code style with the same .clang-format file on Windows and on WSL. And there are GH actions that can be used to check the formatting in the code base.

poodlewars commented 2 months ago

https://github.com/man-group/ArcticDB/pull/1769