Шаблон каталога курса для студентов

Скачать репозиторий

git clone --recursive https://github.com/yamadharma/course-directory-student-template.git

Основные идеи

• Стандартные соглашения об именах
• Стандартное соглашение для путей к файлам
• Стандартная настройка курса внутри шаблона курса

Используемые стандарты и программные продукты

• Стандарт Git Flow.
• Стандарт Семантическое версионирование.
• Стандарт Общепринятые коммиты.

Дополнительное программное обеспечение

Средства разработки

Fedora

• Установите средства разработки:

Quarto

Установка

1. Windows

   • Chocolatey (см. Пакетный менеджер для Windows. Chocolatey):

2. Linux

   1. Linux в общем

      • Установка с помощью скрипта:

   2. Gentoo

      • Gentoo, репозиторий karma:

   3. Arch

      • Arch linux:

      • Manjaro linux:

   4. Fedora

      • Установка из CORP:

Общепринятые коммиты

Установка Node.js

• На Node.js базируется программное обеспечение для семантического версионирования и общепринятых коммитов.

• Для управления пакетами лучше использовать

  pnpm
  , но можно и
  yarn
  .

• Gentoo

  • Node.js:

  • pnpm ставим из оверлея

    guru
    :

• Ubuntu

• Fedora

• Windows

  • Chocolatey:

• MacOS

Настройка Node.js

Для работы с Node.js добавим каталог с исполняемыми файлами, устанавливаемыми пакетным менеджером, в переменную

• Linux
  • pnpm

    • Запустите:

    • Перелогиньтесь, или выполните:

  • yarn

    • В файле

      ~/.bashrc
      добавьте к переменной
      PATH
      :

Установка git-flow

• Linux

  • Gentoo

  • Ubuntu

  • Fedora

    • Устанавливается из COPR:

• Windows Git-flow входит в состав пакета git.

• MacOS

Общепринятые коммиты

1. commitizen

   • Данная программа используется для помощи в форматировании коммитов.

     • pnpm:

     • yarn:

   • При этом устанавливается скрипт
     git-cz
     , который мы и будем использовать для коммитов.

2. standard-version

   • Данная программа автоматизирует изменение номера версии.

     • pnpm:

     • yarn:

Общие правила

• Для именования каталогов и файлов будем использовать соглашение Denote.

• Рабочее пространство по предмету располагается в следующей иерархии:

• Например, для 2025-2026 учебного года (второй семестр) и предмета «Операционные системы» (код предмета

  os-intro
  ) структура каталогов примет следующий вид:

• Название проекта на хостинге git имеет вид:

• Например, для 2025-2026 учебного года и предмета «Операционные системы» (код предмета

  os-intro
  ) название проекта примет следующий вид:

• Каталог для лабораторных работ имеет вид

  labs
  .

• Каталоги для лабораторных работ имеют вид

  lab<номер>
  , например:
  lab01
  ,
  lab02
  и т.д.

• Каталог для групповых проектов имеет вид

  group-project
  .

• Каталог для персональных проектов имеет вид

  personal-project
  .

• Каталог для внешнего курса имеет вид

  external-course
  .

• Если проектов несколько, то они нумеруются подобно лабораторным работам.

• Этапы проекта обозначаются как

  stage<номер>
  .

Шаблон для рабочего пространства

• Репозиторий: https://github.com/yamadharma/course-directory-student-template.

Сознание репозитория курса на основе шаблона

• Репозиторий на основе шаблона можно создать либо вручную, через web-интерфейс, либо с помощью утилит
  gh
  .

Создание с помощью утилит

• Создание выглядит следующим образом:

• Например, для 2024-2025 учебного года и предмета «Операционные системы» (аббревиатура предмета —

  os-intro
  ) создание репозитория примет следующий вид:

Создание вручную

• Сделать свой репозиторий на основе шаблона можно и вручную: https://docs.github.com/ru/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.

Структура шаблона

• Посмотреть доступные цели

  make
  :

• Посмотреть список доступных курсов:

• При создании структуры название курса берётся из следующих мест:

  • название курса находится в файле
    COURSE
    ;
  • каталог курса называется как аббревиатура курса.

Настройка каталога курса

• Перейдите в каталог курса:

• Создайте необходимые каталоги:

• Отправьте файлы на сервер:

Использование git flow

• Будем использовать для работы git flow.

Конфигурация git-flow

• Инициализируем git-flow

  Префикс для ярлыков установим в

  v
  .

• Проверьте, что Вы на ветке

  develop
  :

• Загрузите весь репозиторий в хранилище:

• Создадим релиз с версией 1.0.0

• Создадим журнал изменений

• Добавим журнал изменений в индекс

• Зальём релизную ветку в основную ветку

• Отправим данные на github

• Скопируем CHANGELOG.md в каталог

  release
  :

• Создадим релиз на github. Для этого будем использовать утилиты работы с github (см. github: утилиты командной строки):

Видео