Skip to content

Add Homebrew and SwiftFormat guidelines #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graycampbell merged 3 commits into from
Apr 18, 2025
Merged

Add Homebrew and SwiftFormat guidelines #57

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ba4b4e
Add Homebrew and SwiftFormat guidelines
graycampbell Apr 18, 2025
6030310
Update CONTRIBUTING.md
graycampbell Apr 18, 2025
27c229e
Update CONTRIBUTING.md
graycampbell Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down