Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (32 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 2.35 KB

Установка и настройка проекта

  1. Клонируем репозиторий
  2. В терминале переходим в папку с проектом:
cd Jetpack-WorkoutApp
  1. Устанавливаем все инструменты (справка доступна по команде make help):
make setup
  1. Открываем проект в Android Studio
  2. Ждем синхронизацию Gradle
  3. Проект готов к работе!

Примечание: Команда make setup автоматически настроит Git хуки и сделает их исполняемыми.

Pre-commit hook

Проект использует pre-commit hook для автоматического обновления версий в README.md:

  • Что делает: Перед каждым коммитом автоматически обновляет бейджи с версиями (Kotlin, Android SDK, Gradle, AGP) в README.md
  • Как работает: Запускает Gradle-таск updateReadmeVersions, который считывает актуальные версии из файлов проекта
  • Установка: Автоматически настраивается при выполнении make setup

Ручное обновление версий:

./gradlew updateReadmeVersions
# или
make update_readme_versions

Общие правила

  1. Для доработок создаем issue с описанием задачи
  2. Доработки делаем в отдельных ветках
  3. Все тесты должны успешно проходить
  4. Для каждого PR необходимо оставить описание на русском языке по аналогии со старыми PR
  5. Вопросы по android-приложению решаем с Oleg991 в почте, телеграм или в issue с подробным описанием проблемы
  6. Вопросы по бэкенду/сайту - c Антоном в почте или в issue с подробным описанием проблемы