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

AVRO-3051: Reformatted C++ sources to make them consistent #1154

Merged
merged 8 commits into from
Mar 29, 2021

Conversation

thiru-mg
Copy link
Contributor

Make sure you have checked all steps below.

Jira

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason: This is a format-only change

Commits

  • My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain Javadoc that explain what it does

@thiru-mg thiru-mg self-assigned this Mar 25, 2021
@github-actions github-actions bot added the C++ Pull Requests for C++ binding label Mar 25, 2021
Copy link
Contributor

@RyanSkraba RyanSkraba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello! I checked that there's no functional changes, just whitespace and formatting, so LGTM from that point. I have no opinion on the formatting used.

It would be great to put the name of the beautifier tool and/or settings in the lang/c++/readme file for future reference as a best practice. I find that very helpful when contributing to a new project!

@RyanSkraba RyanSkraba changed the title Reformatted C++ sources to make them consistent AVRO-3051: Reformatted C++ sources to make them consistent Mar 25, 2021
@github-actions github-actions bot added the build label Mar 26, 2021
@thiru-mg
Copy link
Contributor Author

Hello! I checked that there's no functional changes, just whitespace and formatting, so LGTM from that point. I have no opinion on the formatting used.

It would be great to put the name of the beautifier tool and/or settings in the lang/c++/readme file for future reference as a best practice. I find that very helpful when contributing to a new project!

I added a new config file .clang-format and build target format. Now ./build.sh format will format the code provided clang-format has been installed on the system.

@RyanSkraba
Copy link
Contributor

Awesome for the script, thanks! LGTM, I checked that:

  1. m̀aster + .clang-format (1.10.1) with returns essentially the results in this branch (one or two whitespace choices), and
  2. this commit is consistent with the rules provided: ./build.sh format doesn't make any diff

@emkornfield
Copy link
Contributor

Skimmed and looks good to me, as well. A heads up to the ML might still be worthwhile because people like to bikeshed this stuff. As a follow-up it would be great to add a CI rule that verifies applying PRs are consistent with clang-format.

@thiru-mg thiru-mg merged commit 39de1e2 into apache:master Mar 29, 2021
@thiru-mg thiru-mg deleted the thiru_AVRO-3051-4 branch March 29, 2021 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build C++ Pull Requests for C++ binding
Projects
None yet
4 participants