Skip to content

[Infra] Update README.md code formatting docs #158

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
ncooke3 merged 2 commits into from
Mar 5, 2025
Merged

[Infra] Update README.md code formatting docs #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca10c61
[Infra] Update README.md code formatting docs
ncooke3 Mar 5, 2025
abdf40e
Update README.md
ncooke3 Mar 5, 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
13 changes: 2 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,17 +206,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@19
brew install mint
```
See [firebase-ios-sdk's code formatting docs][firebase-ios-sdk-formatting].

### Running Unit Tests

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

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