Skip to content

Commit 65714e0

Browse files
committed
Layout structure
1 parent ff23c37 commit 65714e0

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
6. [User Input](#user-input)
1010
7. [Security](#security)
1111
8. [Performance](#performance)
12-
9. [Null and Infinite Cases](#null-and-infinite-cases)
12+
9. [Testing](#testing)
13+
10. [Miscellaneous](#miscellaneous)
1314

1415
## Introduction
1516
Code reviews can inspire dread in both reviewer and reviewee. Having your
@@ -110,6 +111,8 @@ be split apart.
110111
1130: }
111112
```
112113

114+
### Functions should be documented
115+
113116
## Side Effects
114117

115118
### Functions should be as pure as possible
@@ -183,3 +186,28 @@ particular language and runtime environment. Below is a very small and
183186
incomplete list of common security problems. Don't rely on this alone! Automate
184187
as much security review as you can on every commit, and perform routine security
185188
audits.
189+
190+
## Performance
191+
192+
### Functions should use efficient algorithms and data structures
193+
This is different for every particular case, but use your best judgment to see
194+
if there are any ways to improve the efficiency of a piece of code. Your users
195+
will thank you!
196+
197+
### Actions should be logged
198+
Logging helps give metrics
199+
200+
## Testing
201+
202+
### New code should be tested
203+
204+
### Tests should actually test what the function is doing
205+
206+
## Miscellaneous
207+
> _"Everything can be filed under miscellaneous"_
208+
209+
> George Bernard Shaw
210+
211+
### Null cases should be handled
212+
213+
### Large cases should be handled

0 commit comments

Comments
 (0)