Add a convenience script for consistent astyle formatting #1861
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
Signed-off-by: Spencer Wilson <[email protected]>
Signed-off-by: Spencer Wilson <[email protected]>
Signed-off-by: Spencer Wilson <[email protected]>
Signed-off-by: Spencer Wilson <[email protected]>
dstebila
approved these changes
Jul 25, 2024
rtjk
pushed a commit
to rtjk/liboqs
that referenced
this pull request
Aug 5, 2024
…um-safe#1861) * Add script to format code in a CI container * Update CONTRIBUTING.md to document script --------- Signed-off-by: Spencer Wilson <[email protected]> Signed-off-by: rtjk <[email protected]>
This was referenced Aug 8, 2024
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.
The behaviour of
astylevaries across versions and platforms, which means it can sometimes be a pain to get PRs to pass CI formatting checks. This PR adds a convenience script which runsastyleover local code in the CI Docker image, ensuring that local formatting matches what's expected by CI.My hope is that this script will reduce friction for new contributors and busywork for regular ones. I've been using this approach for a while myself.