Skip to content

Обновление README.md после реализации Этапа 3 (Комментарии)#106

Merged
impatient0 merged 1 commit intofeaturefrom
feature_update-readme-final
Jun 1, 2025
Merged

Обновление README.md после реализации Этапа 3 (Комментарии)#106
impatient0 merged 1 commit intofeaturefrom
feature_update-readme-final

Conversation

@impatient0
Copy link
Owner

@impatient0 impatient0 commented Jun 1, 2025

Описание

Данный Pull Request обновляет основной файл README.md проекта для отражения завершения Этапа 3 (реализация дополнительной функциональности "Комментарии") и актуализации общей информации о проекте.

Ключевые изменения в README.md:

  1. Добавлен раздел "API Спецификации": Включены ссылки на официальные спецификации API основного сервиса и сервиса статистики. Уточнено, что описание эндпоинтов для комментариев находится в основном README или в локально обновленной спецификации.
  2. Актуализированы разделы "Технологии" и "Структура проекта": Добавлены упоминания QueryDSL, Spring AOP, MapStruct, модуля ewm-common и использования schema.sql.
  3. Обновлены инструкции по запуску: Уточнен процесс запуска через Docker Compose и локально из IntelliJ IDEA (с профилями *-local и application-local.yml).
  4. Добавлен раздел "Примеры использования API": Включены примеры GET-запросов к основным публичным эндпоинтам, включая новый эндпоинт для получения комментариев к событию.
  5. Добавлен и детализирован раздел "Реализованная Дополнительная Функциональность: Комментарии":
    • Явно указано, что была выбрана и реализована фича "Комментарии к событиям".
    • Предоставлен подробный обзор реализованного функционала, включая описание возможностей для пользователей (Private API), администраторов (Admin API) и публичного доступа (Public API).
    • Описаны ключевые бизнес-правила (например, 6 часов на редактирование, "мягкое" удаление, управление commentsEnabled в Event).
    • Дана ссылка на (локально обновленную) спецификацию API или указано, что данный раздел README служит ТЗ для фичи.
  6. Добавлен подраздел "Postman-тесты для Дополнительной Функциональности" в секцию "Тестирование", с указанием расположения файла postman/feature.json.

@impatient0 impatient0 self-assigned this Jun 1, 2025
@impatient0 impatient0 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 1, 2025
@impatient0 impatient0 merged commit 1048411 into feature Jun 1, 2025
2 checks passed
@impatient0 impatient0 deleted the feature_update-readme-final branch June 1, 2025 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants