Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 894 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 894 Bytes

Contribution Guidelines

General Guidelines

  • Min iOS SDK: 9.0
  • Min macOS SDK: 10.10
  • Language: Swift (v3)
  • Tests: Yes, please

Architecture guidelines

  • Avoid singletons that don't encapsulate a finite resource
  • Never expose mutable state
  • Public API designed to be called safely from any thread
  • Keep classes/methods sharply focused
  • Stay generic

Style Guide

Base style:

Please add new code to this project based on the following style guidelines:

Additions:

  • Prefix all class names with YM
  • Group related methods with //MARK:
  • Keep as much of the API private as is practically possible