Skip to content

Commit 6a8a677

Browse files
author
Chris Pilcher
committed
Added instructions for running SwiftLint to the "How to Contribute" page
1 parent e164943 commit 6a8a677

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

How to Contribute.markdown

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ To keep this a high quality repo, please follow this process when submitting you
2323
3. Write an explanation of how the algorithm works. Include **plenty of examples** for readers to follow along. Pictures are good. Take a look at [the explanation of quicksort](Quicksort/) to get an idea.
2424
4. Include your name in the explanation, something like *Written by Your Name* at the end of the document. If you wrote it, you deserve the credit and fame.
2525
5. Add a playground and/or unit tests.
26+
6. Run [SwiftLint](https://github.com/realm/SwiftLint)
27+
- [Install](https://github.com/realm/SwiftLint#installation)
28+
- Open terminal and run the `swiftlint` command:
29+
30+
```
31+
cd path/to/swift-algorithm-club
32+
swiftlint
33+
```
34+
2635

2736
Just so you know, I will probably edit your text and code for grammar etc, just to ensure a certain level of polish.
2837

0 commit comments

Comments
 (0)