Даниил Музыченко
33 lines
2.5 KiB
Markdown
33 lines
2.5 KiB
Markdown
# Contributing to Armstrong Vision
|
|
|
|
Спасибо за интерес к проекту. Ниже — как предложить изменения и что ожидать от ревью.
|
|
|
|
Thank you for your interest. Below is how to propose changes and what to expect from review.
|
|
|
|
## Окружение / Environment
|
|
|
|
Монорепозиторий: **Rails API** (`api/`), **React + Vite** (`frontend/`), **PostgreSQL**, **Docker Compose** и **Makefile** в корне. Подробности запуска — в [`README.md`](README.md).
|
|
|
|
## Как предложить изменение / How to propose a change
|
|
|
|
1. Создайте ветку от актуального `main` (или основной ветки репозитория).
|
|
2. Вносите правки небольшими логичными коммитами с понятными сообщениями.
|
|
3. Откройте pull request с кратким описанием: **что** сделано и **зачем**.
|
|
4. Укажите, как вы проверяли изменения (команды, сценарии в UI).
|
|
|
|
## Проверки перед PR / Checks before opening a PR
|
|
|
|
- **Docker (рекомендуется):** из корня — `make prepare`, при необходимости `make dev` или целевые цели из `make help`.
|
|
- **API (локально):** `cd api && bin/rails test` (и при необходимости `bin/rubocop` согласно настройкам проекта).
|
|
- **Frontend (локально):** `cd frontend && npm run lint` и `npm run build`, если менялись зависимости или сборка.
|
|
|
|
При изменении схемы БД приложите миграции и опишите шаги отката/миграции для существующих установок.
|
|
|
|
## Стиль кода / Code style
|
|
|
|
Следуйте существующим соглашениям в репозитории (форматирование, именование, структура каталогов). Не смешивайте в одном PR несвязанный рефакторинг и исправление бага, если это не необходимо для задачи.
|
|
|
|
## Лицензия / License
|
|
|
|
Внося вклад, вы соглашаетесь, что ваш код будет распространяться на условиях **GNU General Public License v3** (см. [`LICENSE`](LICENSE)), если с мейнтейнерами не оговорено иное.
|