From 7ba4b4e86902d2f232f07ea7f51050546176888e Mon Sep 17 00:00:00 2001 From: Gray Campbell <12163070+graycampbell@users.noreply.github.com> Date: Fri, 18 Apr 2025 12:57:10 -0500 Subject: [PATCH 1/3] Add Homebrew and SwiftFormat guidelines Signed-off-by: Gray Campbell <12163070+graycampbell@users.noreply.github.com> --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 323484d..63fedf0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,9 +14,29 @@ > > Thank you for helping us make this project the best it can be! +- [Homebrew](#homebrew) +- [Code Formatting](#code-formatting) - [Signed Commits Required](#signed-commits-required) - [Commit Messages & PR Titles](#commit-messages--pr-titles) +## Homebrew + +This project uses [Homebrew](https://brew.sh) to manage certain dependencies required for development. These +dependencies are defined in the [`Brewfile`](https://github.com/fetch-rewards/SwiftSyntaxSugar/blob/main/Brewfile) +located at the repository's root. + +To install these dependencies, use the command line to navigate to the repository’s root and run the following command: +``` +brew bundle +``` + +## Code Formatting + +This project uses [`SwiftFormat`](https://github.com/nicklockwood/SwiftFormat) to maintain consistent code formatting. +We do not currently automate the process of formatting code, but our CI workflow does use `SwiftFormat` as a linter to +validate that all code changes adhere to our formatting rules. Before creating a PR, please run `SwiftFormat` on all +new or updated files and commit the changes. + ## Signed Commits Required All contributions to this project must use **signed commits**. This is an important part of our commitment to security, From 6030310443d39c08edd1f38259f3fe439eecd333 Mon Sep 17 00:00:00 2001 From: Gray Campbell <12163070+graycampbell@users.noreply.github.com> Date: Fri, 18 Apr 2025 13:00:50 -0500 Subject: [PATCH 2/3] Update CONTRIBUTING.md Signed-off-by: Gray Campbell <12163070+graycampbell@users.noreply.github.com> --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63fedf0..4a46239 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,8 +34,8 @@ brew bundle This project uses [`SwiftFormat`](https://github.com/nicklockwood/SwiftFormat) to maintain consistent code formatting. We do not currently automate the process of formatting code, but our CI workflow does use `SwiftFormat` as a linter to -validate that all code changes adhere to our formatting rules. Before creating a PR, please run `SwiftFormat` on all -new or updated files and commit the changes. +validate that all code changes adhere to our formatting rules. Before creating a PR, please run `SwiftFormat` on all new +or updated files and commit the changes. ## Signed Commits Required From 27c229e0052400b480ce972b7142fb70c88aa926 Mon Sep 17 00:00:00 2001 From: Gray Campbell <12163070+graycampbell@users.noreply.github.com> Date: Fri, 18 Apr 2025 13:01:23 -0500 Subject: [PATCH 3/3] Update CONTRIBUTING.md Signed-off-by: Gray Campbell <12163070+graycampbell@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a46239..237178b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ brew bundle This project uses [`SwiftFormat`](https://github.com/nicklockwood/SwiftFormat) to maintain consistent code formatting. We do not currently automate the process of formatting code, but our CI workflow does use `SwiftFormat` as a linter to -validate that all code changes adhere to our formatting rules. Before creating a PR, please run `SwiftFormat` on all new +validate that all code changes adhere to our formatting rules. Before creating a PR, please run `swiftformat` on all new or updated files and commit the changes. ## Signed Commits Required