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

Update Code to Reflect Style Guide #287

Open
6 tasks
Kfeavel opened this issue Aug 7, 2021 · 1 comment
Open
6 tasks

Update Code to Reflect Style Guide #287

Kfeavel opened this issue Aug 7, 2021 · 1 comment
Labels
easy Should be easy, good for newcomers

Comments

@Kfeavel
Copy link
Member

Kfeavel commented Aug 7, 2021

Areas of Concern:

  • Namespaces (CamelCase)
  • Variable naming (lowerCamelCase)
  • Functions that should be static
  • Missing function prototypes
  • Single-line while loops should use continue (i.e. while (bool) continue;)
    • Add AllowShortLoopsOnASingleLine: true to .clang-format
  • Visit Clang Format Docs and check for other options to enable

These can be separate pull requests, so format the branch names as 287-code-cleanup-(insert category here)

@Kfeavel Kfeavel added the easy Should be easy, good for newcomers label Aug 7, 2021
@Kfeavel
Copy link
Member Author

Kfeavel commented Aug 9, 2021

---
Language: Cpp
BasedOnStyle: WebKit

NamespaceIndentation: None
IndentPPDirectives: AfterHash
SpaceAfterTemplateKeyword: false
BraceWrapping:
    AfterFunction: true

BreakBeforeInheritanceComma: true
BreakConstructorInitializers: BeforeComma
BreakBeforeBraces: Custom

AllowShortBlocksOnASingleLine: Always

AlignConsecutiveAssignments: AcrossComments
AlignConsecutiveBitFields: AcrossEmptyLinesAndComments
AlignConsecutiveMacros: AcrossComments
AlignTrailingComments: true
AlignEscapedNewlines: Left
AlignOperands: AlignAfterOperator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy Should be easy, good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant