Skip to content

Commit 4bcfd5f

Browse files
authored
Add Homebrew and SwiftFormat guidelines (#57)
Signed-off-by: Gray Campbell <12163070+graycampbell@users.noreply.github.com>
1 parent 9230667 commit 4bcfd5f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,29 @@
1414
>
1515
> Thank you for helping us make this project the best it can be!
1616
17+
- [Homebrew](#homebrew)
18+
- [Code Formatting](#code-formatting)
1719
- [Signed Commits Required](#signed-commits-required)
1820
- [Commit Messages & PR Titles](#commit-messages--pr-titles)
1921

22+
## Homebrew
23+
24+
This project uses [Homebrew](https://brew.sh) to manage certain dependencies required for development. These
25+
dependencies are defined in the [`Brewfile`](https://github.com/fetch-rewards/SwiftSyntaxSugar/blob/main/Brewfile)
26+
located at the repository's root.
27+
28+
To install these dependencies, use the command line to navigate to the repository’s root and run the following command:
29+
```
30+
brew bundle
31+
```
32+
33+
## Code Formatting
34+
35+
This project uses [`SwiftFormat`](https://github.com/nicklockwood/SwiftFormat) to maintain consistent code formatting.
36+
We do not currently automate the process of formatting code, but our CI workflow does use `SwiftFormat` as a linter to
37+
validate that all code changes adhere to our formatting rules. Before creating a PR, please run `swiftformat` on all new
38+
or updated files and commit the changes.
39+
2040
## Signed Commits Required
2141

2242
All contributions to this project must use **signed commits**. This is an important part of our commitment to security,

0 commit comments

Comments
 (0)