Conversation
Owner
Author
|
This PR is still in progress (it might take a few commits to complete). |
Codecov Report
@@ Coverage Diff @@
## master #209 +/- ##
==========================================
- Coverage 95.70% 95.59% -0.11%
==========================================
Files 35 35
Lines 3256 3222 -34
==========================================
- Hits 3116 3080 -36
- Misses 140 142 +2
Continue to review full report at Codecov.
|
This file contains hidden or 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
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.
Identify the Bug
The code doesn't follow a proper style guide (more or less accumulated over the years).
This results in less readable code for anyone who wants to propose PRs.
Description of the Change
This change adds a cpplint check on travis and institutes a style guide on the code.
This way, style can be checked on every build (and on every PR). It will also be easier to communicate the style guide to contributors.
Alternate Designs
Using different tools (e.g. clang-tidy). I've decided to use cpplint because I broadly agree with the underlying style (Google code style) - changes to that are minor and can be managed through configuration.
Possible Drawbacks
Noisier builds. PRs might fail on contributors because of style errors. This might slow some people down, but the overall benefit in quality is superior. This is also mitigated by the well-known style guide adopted.
Verification Process
Travis checks.
Release Notes
Added a cpplint check on travis and institutes a style guide on the code.