open-quantum-safe / liboqs

C library for prototyping and experimenting with quantum-resistant cryptography
https://openquantumsafe.org/
Other
1.92k stars 466 forks source link

Add a convenience script for consistent astyle formatting #1861

Closed SWilson4 closed 4 months ago

SWilson4 commented 4 months ago

The behaviour of astyle varies 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 runs astyle over 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.