FreshRSS/NetNewsWire
1
0
Fork 0
mirror of https://github.com/Ranchero-Software/NetNewsWire.git synced 2025-02-09 00:28:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add note about testing; add note about importing AppKit rather than Cocoa.

Browse Source
This commit is contained in:
Brent Simmons 2018-01-28 15:14:33 -08:00
parent 29fe1869aa
commit 9aa1d0a166
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Technotes/CodingGuidelines.md
View File

@ -42,6 +42,8 @@ Extensions, including private extensions, are used — though we take care not t
Things should be marked private as often as possible. APIs should be exactly what’s needed and not more. Things should be marked private as often as possible. APIs should be exactly what’s needed and not more.
When `@importing`, import `AppKit` rather than `Cocoa`. If you see a case where it’s `Cocoa`, change it to `AppKit`. (Reason: importing Cocoa also imports CoreData, which we aren’t using.)
#### Code organization #### Code organization
Properties go at the top, then functions. Properties go at the top, then functions.
@ -150,6 +152,12 @@ Use Instruments to look for leaks and to do profiling. Instruments is great at f
No shipping version gets released without looking for memory leaks. No shipping version gets released without looking for memory leaks.
### Testing
Write unit tests, especially in the lower-level frameworks, and particularly when fixing a bug.
There is never enough test coverage. There should always be more tests.
### Version Control ### Version Control
Every commit message should begin with a present-tense verb. Every commit message should begin with a present-tense verb.