Skip to content

antaliadom-team/frontend

Repository files navigation

Фронтенд проекта Анталия Дом 🏡

Над проектом трудятся:

Как приступить к разработке?

  1. Клонировать репозиторий git clone https://github.com/antaliadom-team/frontend.git
  2. Перейти в папку с проектом cd frontend
  3. Установить зависимости npm install
  4. Выбрать себе доступную задачу и перейти в соответсвующую ей ветку для разработки git checkout название ветки
  5. Запушить изменения с коммитом "что я наделал"
  6. Радоваться что всё прошло успешно 🎉

Несколько требований к проекту

  • Названия файлов и директорий написаны в нижнем регистре и не имеют пробелов, для разделений используется дефис, например: директория my-dir, файл my-component.jsx
  • Стили портированы как модули. Если есть общие стили, они портированы в глобальную область видимости
  • Названия функциональных компонентов написаны с Большой буквы
  • Разметка портирована в JSX, заключена в ( ) и вынесена в соответствующие ей компоненты
  • Хуки не используются внутри условных блоков и вызываются в основной функции компонента
  • Один файл содержит в себе один функциональный компонент
  • Файлы с утилитарными функциями имеют расширение .js
  • Файлы с компонентами имеют расширение .jsx
  • Имена переменных — существительные, имена функций отражают то что они делают
  • Для именования запрещены транслит и неуместные сокращения
  • Код оформлен по принципам программирования DRY:droplet: и KISS:kiss:

Пару слов о том как работать с git

  • Проект содержит основую ветку main. Она предназначена для релизного состояния приложения
  • Ветка dev предназначена для слияния ваших работ
  • Коммиты пишем на русском языке. Начинается коммит с глагола - что сделал(а)?. Например "написал(а) маршрутизацию" или "сделал(а) функцию закрития модального окна на крестик"
  • Если необходимо исправить баг, то создайте ветку с названием hotfix/modal и пул реквест
  • Если пул реквест принят ветка в которой велась разработка удаляется
  • Описал своими словами как мог, подробнее о git-flow можно почитать здесь https://github.com/SergeFocus/git-flow