Skip to content

Commit c5de635

Browse files
authored
Update README with information about linting / formatting (#254)
* Fix CI status badge in README * Update README with information about linting and formatting
1 parent 27307d5 commit c5de635

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
<br/>
99
</p>
1010

11-
12-
[![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)
11+
[![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)
1312
[![](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)
1413
[![](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)
1514

@@ -112,8 +111,12 @@ Swift Transformers is a community project and we welcome contributions. Please
112111
check out [Issues](https://github.com/huggingface/swift-transformers/issues)
113112
tagged with `good first issue` if you are looking for a place to start!
114113

115-
Please ensure your code passes the build and test suite before submitting a pull
116-
request. You can run the tests with `swift test`.
114+
Before submitting a pull request, please ensure your code:
115+
116+
- Passes the test suite (`swift test`)
117+
- Passes linting checks (`swift format lint --recursive .`)
118+
119+
To format your code, run `swift format -i --recursive .`.
117120

118121
## License
119122

0 commit comments

Comments
 (0)