[TASK] Commits #5 (https://github.com/SENATOROVAI/intro-cs/issues/5)

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
          - --warn-only
        exclude: '.*\.md$'
   - repo: https://github.com/PyCQA/docformatter
-    rev: "eb1df347edd128b30cd3368dddc3aa65edcfac38"
+    rev: "v1.7.7"
     hooks:
       - id: docformatter
         args: [--in-place, --wrap-descriptions=120, --style=google]

log.ipynb

@@ -0,0 +1,71 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "a5c7f761",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Module for logging experiment results.'"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "\"\"\"Module for logging experiment results.\"\"\"\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "33ff615f",
+   "metadata": {},
+   "source": [
+    "04/01\n",
+    "1. Закончила выполнение intro, c Cursor разобралась.\n",
+    "2. Начала проходить курс по Python.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f6cb4978",
+   "metadata": {},
+   "source": [
+    "7/01\n",
+    "1. Выполнила quiz 1 b quiz 2"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3ceda156",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.11"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

log.py

@@ -0,0 +1,11 @@
+"""Module for logging experiment results."""
+
+# 04/01
+# 1. Закончила выполнение intro, c Cursor разобралась.
+# 2. Начала проходить курс по Python.
+#
+
+# 7/01
+# 1. Выполнила quiz 1 b quiz 2
+
+#

python/commits.ipynb

@@ -0,0 +1,95 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "84aa8d56",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Commits 5.'"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "\"\"\"Commits 5.\"\"\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a5fe8ea0",
+   "metadata": {},
+   "source": [
+    "1.\tОпишите своими словами назначение каждого из этих типов коммитов:\n",
+    "feat, fix, docs, style, refactor, test, build, ci, perf, chore.  \n",
+    "feat - добавление новой функциональности, то есть добавление новых модулей,  изменение существующего кода, добавление UI-элементов.\n",
+    " Пример: \n",
+    "feat(web): add new icon\n",
+    "fix - используются для обозначения  исправления ошибок(багов) в коде.\n",
+    "Пример: \n",
+    "fix(auth): fix token validation issue\n",
+    "docs - изменения в документации \n",
+    "Пример:\n",
+    "docs(readme): добавлена инструкция по установке \n",
+    "style - внесение правок по стилю(форматирование, пробелы, запятые и т.д.)\n",
+    "Пример: \n",
+    "style: форматирование отступов в модуле авторизации \n",
+    "refactor - изменения(наведение порядка) в коде без изменения его исходной функциональности.\n",
+    "test - добавление или изменение тестов\n",
+    "build - изменения, касающиеся сборки проекта - обновление версий библиотек, изменение скриптов сборки, настройки webpack/npm/gulp, обновление конфигурации Docker (связанной со сборкой).\n",
+    "Пример:\n",
+    "build: add dependencies for UI components\n",
+    "ci - настройка или изменение CI/CD (Continuous Integration/Continuous Delivery)\n",
+    "perl - оптимизация производительности - структурные, синтаксические или функциональные правки в Perl-коде, часто применяемые в рамках обслуживания систем (chore) или исправления ошибок (fix). \n",
+    "Пример: \n",
+    "●\tperl: Fix dependency check in script.pl\n",
+    "chore - прочие задачи (например,  изменения в .gitignore),не меняющие код приложения, не исправляющие ошибки и не меняющие функциональности продукта.\n",
+    "2.\tПредставьте, что вы исправили баг в функции, которая некорректно округляет числа. Сделайте фиктивный коммит и напишите для него сообщение в соответствии с Conventional Commits (используя тип fix).\n",
+    "Ответ: \n",
+    "git commit -m “fix: financial rounding“\n",
+    "3.\tДобавление новой функциональности:\n",
+    "Допустим, вы реализовали новую функцию generateReport в проекте. Сделайте фиктивный коммит с типом feat, отражающий добавление этой функциональности\n",
+    "Ответ: \n",
+    "git commit -m “feat: add function generateReport“\n",
+    "4.\tМодификация формата кода или стилей:\n",
+    "Представьте, что вы поправили отступы и форматирование во всём проекте, не меняя логики кода. Сделайте фиктивный коммит с типом style. \n",
+    "Ответ: \n",
+    "git commit -m “style: replace style errors “\n",
+    "5.\tДокументация и тестирование:\n",
+    "Сделайте фиктивный коммит с типом docs, добавляющий или улучшающий документацию для вашей новой функции.\n",
+    "Ответ: \n",
+    "git commit -m “docs: update README with new contribution guidelines”\n",
+    "Сделайте фиктивный коммит с типом test, добавляющий тесты для этой же функции.\n",
+    "Ответ: \n",
+    "git commit -m “add mock tests”\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.11"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

python/commits.py

@@ -0,0 +1,45 @@
+"""Commits 5."""
+
+# 1.	Опишите своими словами назначение каждого из этих типов коммитов:
+# feat, fix, docs, style, refactor, test, build, ci, perf, chore.
+# feat - добавление новой функциональности, то есть добавление новых модулей,  изменение существующего кода, добавление UI-элементов.
+#  Пример:
+# feat(web): add new icon
+# fix - используются для обозначения  исправления ошибок(багов) в коде.
+# Пример:
+# fix(auth): fix token validation issue
+# docs - изменения в документации
+# Пример:
+# docs(readme): добавлена инструкция по установке
+# style - внесение правок по стилю(форматирование, пробелы, запятые и т.д.)
+# Пример:
+# style: форматирование отступов в модуле авторизации
+# refactor - изменения(наведение порядка) в коде без изменения его исходной функциональности.
+# test - добавление или изменение тестов
+# build - изменения, касающиеся сборки проекта - обновление версий библиотек, изменение скриптов сборки, настройки webpack/npm/gulp, обновление конфигурации Docker (связанной со сборкой).
+# Пример:
+# build: add dependencies for UI components
+# ci - настройка или изменение CI/CD (Continuous Integration/Continuous Delivery)
+# perl - оптимизация производительности - структурные, синтаксические или функциональные правки в Perl-коде, часто применяемые в рамках обслуживания систем (chore) или исправления ошибок (fix).
+# Пример:
+# ●	perl: Fix dependency check in script.pl
+# chore - прочие задачи (например,  изменения в .gitignore),не меняющие код приложения, не исправляющие ошибки и не меняющие функциональности продукта.
+# 2.	Представьте, что вы исправили баг в функции, которая некорректно округляет числа. Сделайте фиктивный коммит и напишите для него сообщение в соответствии с Conventional Commits (используя тип fix).
+# Ответ:
+# git commit -m “fix: financial rounding“
+# 3.	Добавление новой функциональности:
+# Допустим, вы реализовали новую функцию generateReport в проекте. Сделайте фиктивный коммит с типом feat, отражающий добавление этой функциональности
+# Ответ:
+# git commit -m “feat: add function generateReport“
+# 4.	Модификация формата кода или стилей:
+# Представьте, что вы поправили отступы и форматирование во всём проекте, не меняя логики кода. Сделайте фиктивный коммит с типом style.
+# Ответ:
+# git commit -m “style: replace style errors “
+# 5.	Документация и тестирование:
+# Сделайте фиктивный коммит с типом docs, добавляющий или улучшающий документацию для вашей новой функции.
+# Ответ:
+# git commit -m “docs: update README with new contribution guidelines”
+# Сделайте фиктивный коммит с типом test, добавляющий тесты для этой же функции.
+# Ответ:
+# git commit -m “add mock tests”
+#