https://github.com/Lickability/swift-best-practices

A repository that contains information related to Lickability's best practices.
https://github.com/Lickability/swift-best-practices

Last synced: 3 months ago
JSON representation

A repository that contains information related to Lickability's best practices.

• Host: GitHub
• URL: https://github.com/Lickability/swift-best-practices
• Owner: Lickability
• Created: 2018-02-16T21:54:00.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-01-17T21:15:57.000Z (10 months ago)
• Last Synced: 2024-04-20T17:00:30.240Z (7 months ago)
• Homepage:
• Size: 281 KB
• Stars: 823
• Watchers: 26
• Forks: 71
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Lickability Swift Best Practices Guide

Code is written for humans. I’m not the first to say that, and won’t be the last. What you write will eventually be compiled away into something unintelligible, so how you choose to write code isn’t for the computer’s benefit. It’s for yourself, both now and later. It’s for any people working on a team with you. And it’s for anyone that stumbles upon your code after you’re gone.

In order to understand our code better, Lickability employs consistent practices—and to do that, we have a defined structure and style for the way we write code. This style guide is intended to be a living repository that will be updated as the Swift language and our experience evolves. You can click through the links below to read individual sections, or you can read the full document [here](https://github.com/Lickability/swift-best-practices/blob/main/CombinedDocument.md).

If you want to use this, great! If you want to fork it and make changes, go ahead. We won't be accepting issues or pull requests at this time, but we hope that you'll find it our approach to writing software interesting-and if there are aspects that you'd love to chat about, let us know!

## Architecture Info

[Architecture Development Diagram](https://github.com/Lickability/swift-style-guide/blob/main/ArchitectureDiagram.md)

* **M** - [Model](https://github.com/Lickability/swift-style-guide/blob/main/Model.md)

* **V** - [View](https://github.com/Lickability/swift-style-guide/blob/main/View.md)

* **C** - [Controller](https://github.com/Lickability/swift-style-guide/blob/main/Controller.md)

* **VM** - [View Model](https://github.com/Lickability/swift-style-guide/blob/main/ViewModel.md)

### SwiftUI

* [General Best Practices](https://github.com/Lickability/swift-style-guide/blob/main/SwiftUIBestPractices.md)

* [View Store](https://github.com/Lickability/swift-style-guide/blob/main/ViewStore.md)

### Related Resources

* [Common Controller Types](https://github.com/Lickability/swift-style-guide/blob/main/CommonControllerTypes.md)

* [Access Control](https://github.com/Lickability/swift-style-guide/blob/main/AccessControl.md)

## Organizational Info 

* [Assets](https://github.com/Lickability/swift-style-guide/blob/main/Assets.md)

* [Documentation and Comments](https://github.com/Lickability/swift-style-guide/blob/main/DocumentationAndComments.md)

* [Extensions](https://github.com/Lickability/swift-style-guide/blob/main/Extensions.md)

* [Imports](https://github.com/Lickability/swift-style-guide/blob/main/Imports.md)

* [Organization Within a File](https://github.com/Lickability/swift-style-guide/blob/main/OrganizationWithinAFile.md)

* [Project Groups](https://github.com/Lickability/swift-style-guide/blob/main/ProjectGroups.md)

## Technical Info

* [Custom Operators](https://github.com/Lickability/swift-style-guide/blob/main/CustomOperators.md)

* [Default Parameters](https://github.com/Lickability/swift-style-guide/blob/main/DefaultParameters.md)

* [Localization](https://github.com/Lickability/swift-style-guide/blob/main/Localization.md)

* [Naming](https://github.com/Lickability/swift-style-guide/blob/main/Naming.md)

* [Interface Builder](https://github.com/Lickability/swift-style-guide/blob/main/InterfaceBuilder.md)

* [Object Communication](https://github.com/Lickability/swift-style-guide/blob/main/Object%20Communication.md)

* [Optionals](https://github.com/Lickability/swift-style-guide/blob/main/Optionals.md)

* [Protocols](https://github.com/Lickability/swift-style-guide/blob/main/Protocols.md)

* [Testing](https://github.com/Lickability/swift-style-guide/blob/main/Testing.md)

* [Zero Usage](https://github.com/Lickability/swift-style-guide/blob/main/Zero%20Usage.md)

## Style

We use [SwiftLint](https://github.com/realm/SwiftLint) for code linting. We avoid making style comments on pull requests wherever possible, instead allowing the linter to catch them while developing. The fully documented `.yml` file we use is located [here](https://github.com/Lickability/swift-style-guide/blob/main/.swiftlint.yml).

## SwiftUI / Combine

The majority of this document was written prior to the introduction of SwiftUI and Combine. As we become more familiar with these technologies and use them in our own projects, we expect them to reshape the best practices as it exists today.