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

Formatting #35

Open
ethanmusser opened this issue Aug 3, 2022 · 3 comments
Open

Formatting #35

ethanmusser opened this issue Aug 3, 2022 · 3 comments
Labels
bug Something isn't working priority-low Low priority issues

Comments

@ethanmusser
Copy link
Collaborator

ethanmusser commented Aug 3, 2022

Our code is not keeping up with the Google/Drake style guide. We should do a series of formatting commits to bring things up to spec and create a ignore-revs-file file to keep blames honest. Also, might be worth considering a lint-on-push action.

@ethanmusser ethanmusser added the documentation Improvements or additions to documentation label Aug 3, 2022
@ethanmusser ethanmusser added bug Something isn't working and removed documentation Improvements or additions to documentation labels Aug 3, 2022
@jdcaporale
Copy link
Contributor

Agreed, how easy is it to add the action?
At the very least we should make sure everyone (including me) are using autoformatters that follow the same patterns.

@ethanmusser
Copy link
Collaborator Author

ethanmusser commented Aug 3, 2022

I actually meant something akin to this action, which runs clang-format and clang-tidy checks.

Taking it a step further, we could each setup pre-commit hooks on our systems which abort the commit if it does not conform to style guide (this one aborts and patches with the fixes automatically). I'm sure this could be written server-side as well if we really wanted.

@ShaneRozenLevy
Copy link
Contributor

If we do any linting checks we will want to have a formatter plugin that enforces that formatting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working priority-low Low priority issues
Projects
None yet
Development

No branches or pull requests

3 participants