feat: add REAMDE.md

2026-07-14 16:55:44 +03:00
parent 9738df1cd0
commit 9b003b95d4
1 changed files with 47 additions and 0 deletions
@@ -0,0 +1,47 @@
+# Контрольные работы: Миха
+
+Добро пожаловать в рабочее пространство для выполнения контрольных работ. В этом репозитории мы учимся писать чистый, качественный и работающий код, используя современные инструменты разработки.
+
+## 🛠 Технологический стек
+* **Язык**: Python
+* **Автоматизация (CI)**: Gitea Actions
+* **Контроль качества**: Ruff (линтер)
+* **Стандарты коммитов**: Commitizen
+
+## 📋 Статус проверок
+[![Gitea Actions Status](https://gitea.dimong.ru/Dimong4/miha-kr/actions/workflows/ci.yaml/badge.svg)](https://gitea.dimong.ru/Dimong4/miha-kr/actions)
+
+---
+
+## 🚀 Как работать с этим репозиторием
+
+### 1. Подготовка окружения
+Перед началом работы убедись, что у тебя установлены:
+* **Git** — для управления версиями.
+* **Python 3.x** — для написания кода.
+* **pip** — для установки зависимостей.
+
+### 2. Установка зависимостей
+Если твое решение требует дополнительных библиотек:
+1. Создай файл `requirements.txt` в корне проекта.
+2. Установи зависимости командой: `pip install -r requirements.txt`.
+3. Обязательно добавь все используемые библиотеки в `requirements.txt`, чтобы они корректно работали в среде автоматической проверки.
+
+### 3. Рабочий процесс (Workflow)
+1. **Создай новую ветку** для своей работы: `git checkout -b task-name`.
+2. **Пиши код** и проверяй его локально.
+3. **Сделай коммит**, соблюдая правила (Commitizen): `git commit -m "feat: добавил решение задачи №1"`.
+4. **Отправь изменения** в репозиторий: `git push origin task-name`.
+
+### 4. Проверка и сдача
+* После `push` перейди на страницу репозитория во вкладку **Actions**.
+* Если горит **зеленая галочка ✅** — работа прошла автоматический контроль качества.
+* Если **красный крестик ❌** — открой логи задачи, исправь замечания линтера и запушь исправления.
+* После успеха создай **Pull Request** из своей ветки в `main` для финальной проверки.
+
+---
+
+## 🎓 Правила
+* **Чистота кода**: Игнорирование предупреждений линтера `Ruff` недопустимо.
+* **Ветка main**: Прямые пуши в `main` запрещены. Ветка защищена правилами CI/CD.
+* **Ответственность**: Ты несешь ответственность за свой код и его работоспособность в CI-среде.