Repository navigation
Point the Progmasoft-authored code at Progmasoft C++ Style - #6
Merged
Merged
Conversation
The contributing guide described only the style of the code derived from Catch2. The code under src/Progmasoft/ and tests/Progmasoft/ is not derived from it and follows Progmasoft C++ Style (https://github.com/Progmasoft/progmasoft-cpp), the C++ guide of the other Progmasoft projects. A new section under "Writing code" says so, keeps the upstream style for the Catch2-derived code so upstream changes still apply cleanly, and records the two deviations the Catch2 API requires: the namespace Progmasoft::Catch3, and exceptions, which report a failed assertion and stay inside the library. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Author
|
Self-review from the diff: docs/contributing.md only, 16 added lines in a new section under 'Writing code'. It states that src/Progmasoft/ and tests/Progmasoft/ follow Progmasoft C++ Style while the Catch2-derived code keeps the upstream style described on the page, and records the two deviations the Catch2 API requires: the Progmasoft::Catch3 namespace (checked against the sources) and exceptions that stay inside the library. It makes no claim about CATCH_MOVE, since the Progmasoft code uses std::move. 88 checks pass. |
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.
Point the Progmasoft-authored code at Progmasoft C++ Style
The contributing guide described only the style of the code derived
from Catch2. The code under src/Progmasoft/ and tests/Progmasoft/ is
not derived from it and follows Progmasoft C++ Style
(https://github.com/Progmasoft/progmasoft-cpp), the C++ guide of the
other Progmasoft projects.
A new section under "Writing code" says so, keeps the upstream style
for the Catch2-derived code so upstream changes still apply cleanly,
and records the two deviations the Catch2 API requires: the namespace
Progmasoft::Catch3, and exceptions, which report a failed assertion and
stay inside the library.