From c5cc4face37e29f4c98128e01110d7af1ee11c0d Mon Sep 17 00:00:00 2001 From: Devon Thomas <166056408+ThomaDevOSU@users.noreply.github.com> Date: Sun, 3 Aug 2025 01:04:53 -0700 Subject: [PATCH] Mention AStyle Formatting in CONTRIBUTING.md (#4867) * :arrow_up: Bump step-security/harden-runner from 2.12.1 to 2.12.2 (#4837) Signed-off-by: Devon Thomas * Fix CI (#4871) * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann * :construction_worker: fix CI Signed-off-by: Niels Lohmann --------- Signed-off-by: Niels Lohmann Signed-off-by: Devon Thomas * Update CONTRIBUTING.md Mentioned Artistic Style formatting under make amalgamate section Signed-off-by: Devon Thomas * Update CONTRIBUTING.md removed > syntax Signed-off-by: Devon Thomas --------- Signed-off-by: Devon Thomas Signed-off-by: Niels Lohmann Signed-off-by: Devon Thomas <166056408+ThomaDevOSU@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Niels Lohmann --- .github/CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5dfb74b51..b0f65230c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -153,6 +153,9 @@ files directly; instead, modify the include/nlohmann sources and regenerate the make amalgamate ``` +Running `make amalgamate` will also apply automatic formatting to the source files using +[`Artistic Style`](https://astyle.sourceforge.net/). This formatting may modify your source files in-place. Be certain to review and commit any changes to avoid unintended formatting diffs in commits. + ## Recommended documentation - The library’s [README file](https://github.com/nlohmann/json/blob/master/README.md) is an excellent starting point to