From 9b003b95d4cef76a3b57ab1cf0f0958db0a24191 Mon Sep 17 00:00:00 2001 From: Dmitry Belan Date: Tue, 14 Jul 2026 16:55:44 +0300 Subject: [PATCH] feat: add REAMDE.md --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..19e042e --- /dev/null +++ b/README.md @@ -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-среде. \ No newline at end of file