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

Code formatting #115

Open
1 of 6 tasks
apple1417 opened this issue Jul 23, 2022 · 1 comment
Open
1 of 6 tasks

Code formatting #115

apple1417 opened this issue Jul 23, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@apple1417
Copy link
Contributor

apple1417 commented Jul 23, 2022

The SDK codebase is a mess of code styles, since it's been passed between so many authors without proper standardization. We should define a standard, and format it to fix.

Tracking:

  • Decide on convention and create config for editorconfig/clang format/others
  • C++ Code formatting
    • Github check for formatting
  • One class/module per file
  • Document all functions/types
    • Github check for documentation
@apple1417 apple1417 added the enhancement New feature or request label Jul 23, 2022
@apple1417 apple1417 moved this from In Progress to Todo in SDK v1.0.0 Jul 23, 2022
@apple1417 apple1417 moved this from Todo to In Progress in SDK v1.0.0 Jul 24, 2022
@apple1417
Copy link
Contributor Author

apple1417 commented Jul 24, 2022

Looking at the following .clang-format

---
Language:        Cpp
BasedOnStyle:    Chromium
ColumnLimit:     100
SortIncludes:    CaseInsensitive
UseTab:          ForContinuationAndIndentation
IndentWidth:     4
TabWidth:        4
InsertBraces:    true
---

Visual studio can pull settings from this file, so we don't need a separate .editorconfig.

InsertBraces relies on clang format version 15, the first release candidate of which is coming out shortly. This issue is on hold until then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Status: In Progress
Development

No branches or pull requests

1 participant