Use tooling to enforce one coding style on whole codebase #3

Closed
opened 2019-09-28 00:13:42 +03:00 by icex2 · 5 comments
icex2 commented 2019-09-28 00:13:42 +03:00 (Migrated from github.com)

Currently, we are looking into clang-format. This should be part of the build pipeline as well to make sure all source code is properly formated using a single style.

Add an additional document with code style rules that are not covered by the clang formatter file, e.g.

  • always add javadoc style documentation to "public" functions
  • naming conventions for functions, variables, namespacing modules etc
Currently, we are looking into clang-format. This should be part of the build pipeline as well to make sure all source code is properly formated using a single style. Add an additional document with code style rules that are not covered by the clang formatter file, e.g. - always add javadoc style documentation to "public" functions - naming conventions for functions, variables, namespacing modules etc
icex2 commented 2019-09-29 00:23:48 +03:00 (Migrated from github.com)

In GitLab by @praxis on Sep 28, 2019, 23:23

May be good to also include some architectural considerations in that supplementary document,
to get people up to speed on patterns for how things are commonly implemented inside bemanitools?

In GitLab by @praxis on Sep 28, 2019, 23:23 May be good to also include some architectural considerations in that supplementary document, to get people up to speed on patterns for how things are commonly implemented inside bemanitools?
icex2 commented 2019-09-29 00:47:36 +03:00 (Migrated from github.com)

Yeah, that sounds like a very useful thing to have to get people onboarded much faster. I try to come up with the fundamental things to get something like a design document kicked off. However, if you or anyone else feels that there is something missing, input is required.

I created a new issue to address this: #27

Yeah, that sounds like a very useful thing to have to get people onboarded much faster. I try to come up with the fundamental things to get something like a design document kicked off. However, if you or anyone else feels that there is something missing, input is required. I created a new issue to address this: #27
icex2 commented 2019-10-20 00:12:49 +03:00 (Migrated from github.com)

mentioned in commit 6741a1f2fd

mentioned in commit 6741a1f2fd6d6efc597ff69641aa6be3212b8727
icex2 commented 2019-10-23 21:22:48 +03:00 (Migrated from github.com)

Merged !6

Merged !6
icex2 commented 2019-10-23 21:22:57 +03:00 (Migrated from github.com)

closed

closed
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Max/djhackersdev_bemanitools#3