From cfa5d7f700d2507ae3099923434c146d7f4ae260 Mon Sep 17 00:00:00 2001 From: Prachi Gauriar Date: Fri, 4 Jul 2025 17:25:57 -0400 Subject: [PATCH] Update readme --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f94e00b..2e15dd7 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,24 @@ View our [changelog](CHANGELOG.md) to see what’s new. ## Development Requirements -DevFoundation requires a Swift 6.1 toolchain to build. We only test on Apple platforms. We follow -the [Swift API Design Guidelines][SwiftAPIDesignGuidelines]. We take pride in the fact that our +DevFoundation requires a Swift 6.1 toolchain to build. We only test on Apple platforms. We follow +the [Swift API Design Guidelines][SwiftAPIDesignGuidelines]. We take pride in the fact that our public interfaces are fully documented and tested. We aim for overall test coverage over 99%. [SwiftAPIDesignGuidelines]: https://swift.org/documentation/api-design-guidelines/ +### Development Setup + +To set up the development environment: + + 1. Run `Scripts/install-git-hooks` to install pre-commit hooks that automatically check code + formatting. + 2. Use `Scripts/lint` to manually check code formatting at any time. + ## Bugs and Feature Requests -Find a bug? Want a new feature? Create a GitHub issue and we’ll take a look. +Find a bug? Want a new feature? Create a GitHub issue and we’ll take a look. ## License