Home

Документация frontend части проекта Sticker Stack

Файловая структура

В корне проекта имеются папки...

Весь интерфейс разбит на отдельные React-компоненты, которые хранятся в папке Components. У каждого компонента имеется своя папка, в ней дочерние файлы - сам компонент, стили к нему.

├── public/
├── src/
|    ├── components/                                   # React components
|    |   ├── UserProfile/
|    |   |   ├── UserProfile.tsx
|    |   |   └── UserProfile.module.scss
|    |   └── Card/
|    |       ├── Card.tsx
|    |       └── Card.module.scss
|    |
|    └── services/                                     # Redux
|        ├── actions/
|        |   ├── UserProfile.ts
|        |   └── Card.ts
|        |
|        └── reducers/
|            ├── UserProfile.ts
|            ├── Card.ts
|            └── index.ts
|
├── README.md
└── LICENSE.md

Требования к именованию файлов:

• Названия директорий в components используют наименование компонента, который в ней расположен
• Название файла компонента (.tsx) повторяет имя директории в которой находится
• Название файла стилей (.scss) повторяет имя директории в которой находится и добавляет к себе .module (Component.module.scss)

Как залить свои изменения

https://www.conventionalcommits.org/ru/v1.0.0/

Как отправить на ревью

Любые изменения должны приходить из новой ветки, которая создана от наиболее поздней версии ветки main. Далее создается пулреквест на слияние этой новой ветки с main. Код должны одобрить хотя бы два человека, прежде чем будет доступен merge. В параметрe Reviewers можно запросить ревью и одобрение у конкретных пользователей.

Шаблон именования веток: feature/<здесь краткое описание содержимого>. Например, feature/authorization, feature/new-design.

Шаблон именования коммитов: <разновидность изменений>: <краткое описание требуемых изменений>. Например, 'fix: rewrite error messages', 'feat: add validation to main form'.

После создания пулреквеста vercel автоматически реализует деплой данной ветки. Посмотреть его можно по ссылке Visit Preview.

После каждого коммита в ветку деплой автоматически обновляется.

Как сделать ревью

На странице пулреквеста нужно найти кнопку "Добавить ревью":

Далее следует проверить все измененные автором файлы. К любой строчке кода можно оставить комментарий. Далее можно прокомментировать, утвердить изменения (approve), либо запросить новые (request chages).

Кодстайл