From 0362a47ff7e5fcb4eb701f6d8bad9a2196d57a52 Mon Sep 17 00:00:00 2001 From: Gareth Reese Date: Thu, 2 May 2024 09:32:28 +0100 Subject: [PATCH] Tidy up the Package.swift and add some docs for contributors --- Package.swift | 5 ----- README.md | 10 +++++++++- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/Package.swift b/Package.swift index 34a07fa..f2c4445 100644 --- a/Package.swift +++ b/Package.swift @@ -23,10 +23,5 @@ let package = Package( name: "FlagsmitClientTests", dependencies: ["FlagsmithClient"], path: "FlagsmithClient/Tests") - // .binaryTarget( - // name: "swiftformat", - // url: "https://github.com/nicklockwood/SwiftFormat/releases/download/0.53.8/swiftformat.artifactbundle.zip", - // checksum: "12c4cd6e1382479cd38bba63c81eb50121f9b2212a8b1f8f5fa9ed1d1c6d07d1" - // ), ] ) diff --git a/README.md b/README.md index 9109835..d619a82 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,15 @@ For full documentation visit [https://docs.flagsmith.com/clients/ios/](https://d ## Contributing -Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code of conduct, and the process for submitting pull requests +Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code of conduct, and the process for submitting pull requests. + +We use [SwiftLint](https://github.com/realm/SwiftLint) and [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) to keep our code consistent. + +To run `swiftformat` on the project run the following command: + + swift package plugin swiftformat + +To run `swiftlint` on the project please check out the documentation above to install the linter with your preferred method of integration. The linter will run on the project when the PR is raised, so it's worth checking beforehand. ## Getting Help