-
Notifications
You must be signed in to change notification settings - Fork 5
Coding Standards
New code added to an existing file must follow the predominant style of that file. All new code must follow the current standards listed here. The goal of these standards are consistency and readability of the code base, even though there may be many different authors.
GeoFeatures2 relies only on pure Swift – no third party libraries are to be used, including Foundation. Be careful to replace import Foundation with import Swift when creating new files in Xcode.
Any code that is of public scope must have comments following Apple's Markup Formatting Reference.
When commenting a method with callouts – return value, parameters, throws, etc. – the callout should be lowercased preceded by a dash and a single space.
Example:
- precondition: The "outerRing" must be oriented clockwise
Code submitted to must be covered by unit tests, otherwise your pull request will not be approved.
- Fork the GeoFeatures2 repository.
- Create your feature branch:
git checkout -b my-new-feature. - Commit your changes:
git commit -am 'A concise description of your commit'. - Push your changes upstream:
git push origin my-new-feature. - Submit a pull request.