Reseach

Разработка и контрибьютинг в проект StarBank

Добро пожаловать в репозиторий StarBank! Этот документ описывает процесс разработки, внесения изменений и участия в проекте. Здесь вы найдете инструкции по настройке окружения, работе с кодом, созданию issue и pull request.

---

🚀 Как начать работу с проектом?

1️⃣ Настройка окружения

Перед началом работы убедитесь, что у вас установлены:

• JDK 17+
• Maven 3.8+
• Docker (опционально, для контейнеризированного запуска)
• Liquibase (для управления миграциями БД)

2️⃣ Клонирование проекта

Склонируйте репозиторий к себе на локальную машину:

git clone https://github.com/idol696/starbank.git
cd starbank

3️⃣ Конфигурация базы данных

Создайте локальный файл .env или настройте application.properties:

spring.datasource.url=jdbc:postgresql://localhost:5432/starbank
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.jpa.hibernate.ddl-auto=validate

Для использования H2 вместо PostgreSQL измените spring.datasource.url:

spring.datasource.url=jdbc:h2:file:./transaction;DB_CLOSE_DELAY=-1;ACCESS_MODE_DATA=r

Запустите миграции Liquibase:

mvn liquibase:update

4️⃣ Сборка и запуск

Запустите приложение с помощью Maven:

mvn spring-boot:run

Или соберите JAR-файл и запустите его:

mvn clean package
java -jar target/starbank.jar

---

📌 Контрибьютинг

🔹 Создание Issue

Перед тем как приступить к работе, проверьте таблицу задач и посмотрите, есть ли уже открытое issue, соответствующее вашей задаче. Если его нет:

1. Откройте новый issue и опишите задачу.
2. Укажите контекст, ожидаемый результат и возможные решения.
3. Назначьте assignee или свяжитесь с командой в комментариях.

🔹 Создание ветки

Перед началом работы создайте новую ветку от develop:

git checkout develop
git pull origin develop
git checkout -b feature/название-фичи

Примеры имен веток:

• feature/add-recommendation-api
• fix/telegram-bot-command
• docs/update-readme

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

Перед коммитами проверьте код:

mvn clean verify

и запустите тесты:

mvn test

🔹 Оформление Pull Request

1. После завершения работы сделайте коммит:

   git add .
   git commit -m "feat: Добавлена логика рекомендаций для пользователей"

2. Отправьте код в удаленный репозиторий:

   git push origin feature/название-фичи

3. Создайте Pull Request на ветку develop, добавьте описание изменений.

ПЫСЫ: для маркировки коммитов используйте feat: - новое, fix: - исправление, hotfix: - срочное исправление

🔹 Код-ревью

Ваш код должен быть просмотрен LD. Если необходимо внести исправления:

• Обсудите комментарии
• Исправьте код
• Дополните тесты (если нужно)

После одобрения LD будет слит в develop.

---

🎯 Контакты

Если у вас есть вопросы или предложения, напишите нам в Issues или создайте Discussion.

Спасибо за вклад в проект!