Skip to content

Commit 34370a1

Browse files
Garrett MosekeGNMoseke
authored andcommitted
docs: add Contributing/Code Formatting section to README
1 parent ccc326d commit 34370a1

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
# swift-numerics-differentiable
1+
# swift-numerics-differentiable
2+
3+
## Contributing
4+
### Code Formatting
5+
This package makes use of [swift-format](https://github.com/swiftlang/swift-format), which is built directly into the swift toolchain as of
6+
swift 6. To apply formatting rules to all files, which you should do before submitting a PR, run from the root of the repository:
7+
8+
```sh
9+
swift format --in-place --recursive .
10+
```
11+
12+
Formatting is validated with the `--strict` flag on every PR

0 commit comments

Comments
 (0)