Skip to content

Commit

Permalink
[Infra] Update README.md code formatting docs (#219)
Browse files Browse the repository at this point in the history
  • Loading branch information
ncooke3 authored Mar 5, 2025
1 parent 670fc1c commit 43a8dd1
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,7 @@ Alternatively disable signing in each target:

### Code Formatting

To ensure that the code is formatted consistently, run the script
[./scripts/check.sh](https://github.com/firebase/firebase-ios-sdk/blob/main/scripts/check.sh)
before creating a PR.

GitHub Actions will verify that any code changes are done in a style compliant
way. Install `clang-format` and `mint`:

```console
brew install clang-format@18
brew install mint
```
See [firebase-ios-sdk's code formatting docs][firebase-ios-sdk-formatting].

### Running Unit Tests

Expand All @@ -187,3 +177,4 @@ The contents of this repository is licensed under the

[gh-actions]: https://github.com/firebase/firebase-ios-sdk/actions
[gh-google-utilities-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/google-utilities/badge.svg
[firebase-ios-sdk-formatting]: https://github.com/firebase/firebase-ios-sdk?tab=readme-ov-file#code-formatting

0 comments on commit 43a8dd1

Please sign in to comment.