8000 Added a note concerning brevity in CONTRIBUTING · DaKing/swift-algorithm-club@fbfd206 · GitHub
[go: up one dir, main page]
Skip to content

Commit fbfd206

Browse files
kelvinlauKLkelvinlauKL
authored
Added a note concerning brevity in CONTRIBUTING
1 parent 2a4af5d commit fbfd206

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Want to help out with the Swift Algorithm Club? Great! While we don't have stric
44

55
**Readability**
66

7-
The `README` file is the cake, and the sample code is the cherry on top. Readablity is really important for us. A good contribution has succinct explanations supported by diagrams. Code is best introduced in chunks, weaved into the explanations where relevant.
7+
Our repo is all about learning. The `README` file is the cake, and the sample code is the cherry on top. A good contribution has succinct explanations supported by diagrams. Code is best introduced in chunks, weaved into the explanations where relevant.
8+
9+
> When choosing between brievity and performance, err to the side of brievity as long as the time complexity of the particular implementation is the same. You can make a note afterwards suggesting a more performant way of doing things.
810
911
**API Design Guidelines**
1012

0 commit comments

Comments
 (0)
0