Skip to content

Coding style

Den Ree edited this page Mar 3, 2017 · 56 revisions

##📒 1️⃣Основные положения

2️⃣Оформление при работе с git

3️⃣Работа с кодом

##Основные положения

  • В своем коде следуйте этим guidelines
  • Не используйте сокращения!
  • В проекте используется Indentation - 2 ‼️ для Tab width, Indent width

Оформление при работе с git

  • Все git commit проходят code review

  • К merge принимаются:

  • Коммиты только warnings ⚠️ на TODO и FIXME от SwiftLint (В release допускаются без warnings)

  • При создании новой ветки указываем тип таски/id таски/краткое описание

Пример:

Задача в трелло -> https://trello.com/c/*oIO4hMDV*/events-screen

Ветка -> feature/*oIO4hMDV*/add-event-screen

  • При создании pull request указываем ссылку на таску из Trello

Работа с кодом

Правила о названиях

  • Protocols that describe what something is should read as nouns (e.g. Collection).
  • Protocols that describe a capability should be named using the suffixes able, ible, or ing (e.g. Equatable, ProgressReporting).
  • Контроллер — это то место, где нет выполняемой логики, но есть взаимодействие разных классов
  • Для расширений <название типа>+<существительное компонента с большой буквы>
  1. Структура проекта должна совпадать со структурой файлов ‼️
  1. При создании extensions для Class придерживаемся следующей логики Extenstions/Class framework/Class/Class+Extension name

Пример:

Для создания String+AddToCalendar используем путь

Extensions/Foundation/String/String+Addtocalendar.swift

Clone this wiki locally