From fd707c7b8a77ba7e7b061c958a6de63f0dc6e510 Mon Sep 17 00:00:00 2001 From: Mattt Zmuda Date: Tue, 23 Sep 2025 13:30:57 -0700 Subject: [PATCH 1/2] Fix CI status badge in README --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c3c4ccd..81a4c8a9 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@

- -[![Unit Tests](https://github.com/huggingface/swift-transformers/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/huggingface/swift-transformers/actions/workflows/unit-tests.yml) +[![Unit Tests](https://github.com/huggingface/swift-transformers/actions/workflows/ci.yml/badge.svg)](https://github.com/huggingface/swift-transformers/actions/workflows/unit-tests.yml) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fhuggingface%2Fswift-transformers%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/huggingface/swift-transformers) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fhuggingface%2Fswift-transformers%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/huggingface/swift-transformers) From 3dd261c9c3c0a8802a9d7d6f82278edb23aaf247 Mon Sep 17 00:00:00 2001 From: Mattt Zmuda Date: Tue, 23 Sep 2025 13:35:35 -0700 Subject: [PATCH 2/2] Update README with information about linting and formatting --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 81a4c8a9..1e42f480 100644 --- a/README.md +++ b/README.md @@ -111,8 +111,12 @@ Swift Transformers is a community project and we welcome contributions. Please check out [Issues](https://github.com/huggingface/swift-transformers/issues) tagged with `good first issue` if you are looking for a place to start! -Please ensure your code passes the build and test suite before submitting a pull -request. You can run the tests with `swift test`. +Before submitting a pull request, please ensure your code: + +- Passes the test suite (`swift test`) +- Passes linting checks (`swift format lint --recursive .`) + +To format your code, run `swift format -i --recursive .`. ## License