SimVascular / SimVascular/svMultiPhysics

Automatically enforce coding standards

Open
#96 15 comments 0 reactions 1 assignee View on GitHub

@mrp089 is already working on this.

Since Sep 12, 2023.

enhancement
Dominant language
C++
Stars
45
Forks
60
Avg merge
5d 23h
Merged PRs (30d)
11

Description

We currently have a "manual" definition of svFSIplus coding standards. I think it would be helpful to automatize what is written here with the widely used C++ code formatter clang-format (see usage here).

It seems like what we have is pretty much the Google C++ Style Guide. If we really need to, we can define modifications in a custom format file.

Once defined (and all existing code is formatted to that), we can only allow commits that satisfy this format as we do in svZeroDPlus. This will save developers time because they can automatically format their code and avoid future discussions about formatting when merging new code.

@ktbolt, please let me know what modifications from the Google C++ style you would like, and I can set up the rest. Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.