-
Notifications
You must be signed in to change notification settings - Fork 35
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
Add C++ code Formatting #420
Open
mabruzzo
wants to merge
7
commits into
enzo-project:main
Choose a base branch
from
mabruzzo:add-cpp-formatting
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…luded within fortran source code
At the last Enzo-E call, it was suggested that I try to format everything and check if it works.
|
pre-commit.ci run EDIT: For posterity, this comment was used to trigger the new pre-commit.ci continutous integration (this was necessary since I introduced precommit.ci after this PR was created and I didn't want to push a new commit) |
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request summary
This PR adds a support for using
clang-format
with Enzo-E.I have added extensive documentation.
Detailed Description
This is something we spoken at length about in the past and there is consensus enforcing standard formatting for C/C++ code would be beneficial.
I feel like this is something we could delay indefinitely. So I made 2 particular choices to make this easier to merge:
Relationship with
pre-commit
The main challenge of using
clang-format
is that it is not forward/backward compatible (picking an established style should mitigate some of these issues). - In other words, you need to apply a consistent version of clang-format everywhere.SOLUTION: To address this challenge, this PR configures the
pre-commit
software andpre-commit.ci
continuous integration service (introduced in #419) to invokeclang-format
.I implemented a similar solution in Cholla and it works well.
This is a major change or addition (that needs 2 reviewers): unknown
Depends on #419
PR Checklist