Skip to content
Анастасия Теслина edited this page Jun 30, 2023 · 13 revisions

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

Полезные ссылки

Развернутый фронтенд - https://cranio-worldwide.tk/

API-документация - https://cranio-worldwide.tk/docs/swagger https://cranio-worldwide.tk/docs/redoc

Дизайн-макет - https://www.figma.com/file/JpurKm6dFwnDQpsdVIKUPC/Cranio-worldwide-2?type=design&node-id=1241%3A10533&mode=design&t=z7LGeRJvsb8oKBqS-1

Фичлист - https://docs.google.com/spreadsheets/d/1L_iIM6PrV0u3Vv1KuId1N_Lskh6gUvCzr8PW-Ok8USI/edit#gid=0

Задачи в общем пространстве - https://qa.princeofprocrastination.art/projects/therapist/issues

https://github.com/orgs/Cranio-worldwide/projects

Документация Next.js - https://nextjs.org/docs/getting-started

Админка - https://cranio-worldwide.tk/admin/

email: root@root.root

password: root


Ветки и коммиты

Пример именования веток:

feature/<здесь краткое описание содержимого>, refactor/<здесь краткое описание рефакторинга> bug/<здесь краткое описание исправления>.

Например, feature/authorization, feature/new-design, bug/form-styles.

Пример именования коммитов:

<разновидность изменений>: <краткое описание требуемых изменений>.

Например, 'fix: rewrite error messages', 'feat: add validation to main form'.

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

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

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

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

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

Файловая структура компонента

Компонент в отдельной папке, где обязательно .tsx и .scss файлы компонента. .scss-файл модульно подключен к .tsx. Таким образом стили каждого компонента изолированы, возможно свободное именование классов.

Пример:

example