Add style guide #164
Merged
Add style guide #164
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
I skimmed through the Google C++ style guide, and looked for any differences in how we do things. I called out the ones I found. We can add more here as we encounter them. Fixes #22.
chiphogg
added
the
release notes: 📝 documentation
Change "the Google style guide" to "the Google C++ Style Guide" (line 58). (We try to use publications' and institutions' preferred styling when we refer to them)
johnzoppina
approved these changes
Aug 14, 2023
Sorry, I didn't quite understand the extra credit part. 😅 |
tobin
approved these changes
Aug 18, 2023
Synced offline. The extra credit was about resolving inconsistencies in style, but since this wasn't trivial I decided to pass. |
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.
I skimmed through the Google C++ style guide, and looked for any
differences in how we do things. I called out the ones I found. We can
add more here as we encounter them.
The result can be previewed here:
https://github.com/aurora-opensource/au/blob/style-guide%2322/CONTRIBUTING.md#style-guide
To test, I clicked every link. They all go to the right anchor,
although some of the later ones seemed to be a little "off" to me in
their location. However, the link is definitely correct, so I think
this is a quirk we can't do anything about.
Fixes #22.