WIP: порядок сдачи работ в Markdown через Git

README.md

@@ -2,4 +2,115 @@
 
 * Методические указания и варианты заданий — в списке файлов выше.
 * [Журнал](https://docs.google.com/spreadsheets/d/1P9XF8Chyo3sBx5sgGW2UriUBv78sLLuHwOadQvefH9s/edit?usp=sharing)
-* [Комментарии к методическим указаниям](comments.md)
+* [Комментарии к методическим указаниям](comments.md)
+
+---
+
+## Работа с Git
+
+**Работы проверяются только после того, как закоммичены по правилам ниже.**
+
+1. В начале семестра
+    создать на сервере копию этого репозитория ("форкнуть" его), нажав *Fork*.
+    Получится репозиторий-форк `http://uit.mpei.ru/git/IvanovII/python`,
+    где `IvanovII` — ваше имя пользователя.
+
+1. В начале каждого занятия
+    перебазировать свой форк на исходный репозиторий ("апстрим"):
+
+    ```sh
+    # Первую команду нужно запускать только один раз,
+    # иначе будет ошибка "error: remote upstream already exists".
+    git remote add upstream http://uit.mpei.ru/git/main/python.git
+    git fetch upstream
+    git stash push
+    git rebase upstream/main
+    git stash pop
+    ```
+
+    Перебазировать нужно, чтобы подтянуть из исходного репозитория обновления.
+
+1. После того, как отчет написан, закоммитить его как `TEMAn/report.md`.
+    Здесь и далее `TEMAn` — каталоги конкретных тем: `TEMA1`, `TEMA2` и т. д.
+    Можно также коммитить по частям в процессе работы.
+    Если для отчета нужны рисунки, то их закоммитить в `TEMAn`,
+    назвав `figure0.png`, `figure1.png` и т. д.
+
+1. Для всех тем, кроме 1 и 8, решение общего контрольного задания (ОКЗ)
+    закоммитить как `TEMAn/task.py`.
+
+1. Для темы 8 решение ОКЗ закоммитить как файлы модулей в `TEMA8/task`.
+
+1. Для темы 1 ответ на индивидуальный контрольный вопрос
+    закоммитить как `TEMA1/test.txt`.
+
+1. Для тем с 2, 4, 5 и 7 решение индивидуального контрольного задания (ИКЗ)
+    закоммитить как `TEMAn/test.py`.
+
+1. Для темы 8 решение ИКЗ закоммитить как файлы модулей в `TEMA8/test`.
+
+1. Для темы 3 и 6 решение теста по модулю закоммитить как `TEMAn/test.py`
+
+1. Для темы 9 файлы с решением теста по модулю закоммитить в `TEMA9/test`.
+
+## Оформление отчета
+
+Отчет `TEMAn/report.md` оформляется в формате Markdown по следующему образцу:
+
+    # Отчет по теме 1
+
+    Иванов Иван, А-01-25
+
+    ## 1 Изучение среды IDLE
+
+    ## 1.1 Настройка текущего каталога
+
+    ```
+    >>> import os
+    >>> os.chdir(r"C:\users\u111-19\Desktop\python\TEMA1")
+    >>> os.getcwd()
+    'C:\\Users\\u111-19\\Desktop\\python\\TEMA1'
+    ```
+
+    Нажал *Файл / Открыть*, диалог оказался сразу нацелен на установленную папку:
+
+    ![Скриншот диалога открытия файла](figure0.png)
+
+Нужно написать приведенный выше текст в `report.md` (например, Блокнотом),
+а рядом разместить изображение `figure0.png`,
+тогда в web-интерфейсе Gitea фрагмент будет отображаться так:
+
+---
+
+# Отчет по теме 1
+
+Иванов Иван, А-01-25
+
+## 1 Изучение среды IDLE
+
+## 1.1 Настройка текущего каталога
+
+```
+>>> import os
+>>> os.chdir(r"C:\users\u111-19\Desktop\python\TEMA1")
+>>> os.getcwd()
+'C:\\Users\\u111-19\\Desktop\\python\\TEMA1'
+```
+
+Нажал *Файл / Открыть*, диалог оказался сразу нацелен на установленную папку:
+
+![Скриншот диалога открытия файла](assets/report-example.png)
+
+---
+
+Заголовки пунктов должны отражать их суть в нескольких словах,
+то есть просто скопировать текст пункта в заголовок не подойдет.
+Вы должны сами придумать осмысленные заголовки, прочитав пункт задания.
+
+В отчет копируется код, введенный в оболочку (строки, начинающиеся с `>>>`),
+и вывод соответствующих команд (`'C:\\Users...` в примере).
+
+Если в пункте задания требуется сделать вывод или объяснить что-то,
+к коду и выводу добавляется письменный ответ или пояснение.
+
+[Узнать больше о формате Markdown.](https://commonmark.org/help/)