secure-software-engineering / phasar

A LLVM-based static analysis framework.
Other
927 stars 140 forks source link

Update Coding Guidelines #539

Closed fabianbs96 closed 1 year ago

fabianbs96 commented 1 year ago

Story

Our current coding guidelines just state that we use those from LLVM. However, we have sometimes different style (also depending on the contributer) that leads to confusion when reading the code, e.g. include order, #include vs forward declaration, template parameter style (D vs d_t) , etc... . We should document precisely, what style should be used in which situation and also automate as much as possible (e.g. adapt the .clang-format file)

Prerequisites

Out Of Scope

Acceptance Criteria

The following acceptance criteria are defined regarding the result of this story: Clarify what the final result should be, not how to accomplish it.

Related Stories

Follow-up Stories

MMory commented 1 year ago

related to #337 #338