Рабочее пространство для лабораторной работы

При выполнении лабораторной работы следует придерживаться структуры рабочего пространства.

Содержание

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

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

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

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

    ~/work/study/
    └── <учебный год>/
        └── <название предмета>/
            └── <код предмета>/
    
  • Например, для 2023–2024 учебного года и предмета «Операционные системы» (код предмета os-intro) структура каталогов примет следующий вид:

    ~/work/study/
    └── 2023-2024/
        └── Операционные системы/
            └── os-intro/
    
  • Название проекта на хостинге git имеет вид:

    study_<учебный год>_<код предмета>
    
  • Например, для 2023–2024 учебного года и предмета «Операционные системы» (код предмета os-intro) название проекта примет следующий вид:

    study_2023-2024_os-intro
    
  • Каталог для лабораторных работ имеет вид labs.

  • Каталоги для лабораторных работ имеют вид lab<номер>, например: lab01, lab02 и т.д.

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

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

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

  • Этапы проекта обозначаются как stage<номер>.

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

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

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

  • Создание выглядит следующим образом:
    gh repo create <new-repo-name> --template="<owner/template-repo>"
    
  • Например, для 2023–2024 учебного года и предмета «Операционные системы» (аббревиатура предмета — os-intro) создание репозитория примет следующий вид:
    mkdir -p ~/work/study/2023-2024/"Операционные системы"
    cd ~/work/study/2023-2024/"Операционные системы"
    gh repo create study_2023-2024_os-intro --template=yamadharma/course-directory-student-template --public
    git clone --recursive git@github.com:<owner>/study_2023-2024_os-intro.git os-intro
    

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

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

  • Посмотреть доступные цели make:
    make help
    
  • Посмотреть список доступных курсов:
    make list
    
  • При создании структуры название курса берётся из следующих мест:
    • название курса находится в файле COURSE;
    • каталог курса называется как аббревиатура курса.

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

  • Перейдите в каталог курса:
    cd ~/work/study/2023-2024/"Операционные системы"/os-intro
    
  • Удалите лишние файлы:
    rm package.json
    
  • Создайте необходимые каталоги:
    echo os-intro > COURSE
    make prepare
    
  • Отправьте файлы на сервер:
    git add .
    git commit -am 'feat(main): make course structure'
    git push
    

Дмитрий Сергеевич Кулябов
Дмитрий Сергеевич Кулябов
Профессор кафедры теории вероятностей и кибербезопасности

Мои научные интересы включают физику, администрирование Unix и сетей.

Похожие