sprff/rust-HSE

★ 0Forks 0RustGitHub ↗Compare

README

Rust HSE 2023

Ссылки

Основное

Коммуникация

Материалы

Настройка окружения

Вся работа с курсом организована на GitHub, у Вас будет собственный репозиторий для решения задач, а также простенький UI раст-хсе.рф для просмотра задач, дедлайнов и т.п.

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

Регистрация в системе раст-хсе.рф

  1. Зарегистрируйтесь в тестирующей системе. Для входа Вам потребуется аккаунт на GitHub. Секретный код: krusty-krab.

  2. После регистрации автоматика добавит Вас в GitHub организацию rust-hse и создаст там для Вас копию репозитория с задачами rust-hse/rust-hse-2023.

Настройка Git

Чтобы работать с git-репозиториями, вам нужно установить и настроить git на своем компьютере, а также аутентифицироваться в GitHub. Пошаговая инструкция ниже. Либо Вы можете проследовать инструкции от GitHub: Set up Git.

Если Вы регулярно работаете с git и GitHub-ом, то скорее всего у Вас все настроено, Вы можете пропустить эти шаги и перейти к шагу клонирования репозитория.

  1. Установите git: https://git-scm.com/downloads

  2. Задайте имя и email (желательно тот же, что вы использовали при регистрации на GitHub):

    git config --global user.name "Ivan Ivanov"
    git config --global user.email [email protected]
  3. Аутентифицируйтесь в GitHub. Тут есть несколько вариантов как это сделать. Опишем два из них: через GitHub CLI (рекомендуемый GitHub-ом) и через SSH.

    • GitHub CLI:

      1. Установите GitHub CLI: https://github.com/cli/cli#installation.

      2. В терминале запустите команду gh auth login и следуйте инструкциям. Отвечайте на вопросы как на этом скриншоте:

        gh auth login result

    • SSH:

      1. Сгенерируйте ssh ключ, если у Вас его еще нет (см. ~/.ssh).

        ssh-keygen -t ed25519 -C "<your email>"
        
      2. Скопируйте сгенерированный публичный ключ.

        cat ~/.ssh/id_ed25519.pub
        
      3. Перейдите в настройки аккаунта, в раздел SSH ключей https://github.com/settings/keys.

      4. Нажмите Add SSH key.

      5. Заполните Title (чем угодно), в поле Key вставьте скопированный публичный ключ. Нажмите Add SSH key.

      6. Проверьте, что ssh ключ работает. Выполните команду ssh -T [email protected]. Вы должны увидеть такое приветствие:

        $ ssh -T [email protected]
        Hi <your login>! You've successfully authenticated, but GitHub does not provide shell access.
        

Клонирование репозитория на компьютер

В нашей GitHub огранизации Вам будут доступны два репозитория: публичный rust-hse-2023 и Ваш личный rust-hse-2023-<your login>. Для сдачи задач Вы будете работать со своим личным репозиторием.

  1. Передите на страницу своего репозитория (если вы не читаете эту инструкцию уже с него). Его можно найти на раст-хсе.рф, перейдя по ссылке MY REPO, или на странице репозиториев организации: https://github.com/orgs/rust-hse/repositories.

  2. Склонируйте cвой репозиторий с задачами. Для этого найдите адрес репозитория:

    github repo clone

    Какой выбрать адрес, зависит от того, как вы настроили git на предыдущем шаге:

    • Если вы использовали GitHub CLI, то попробуйте выполнить

      $ git clone https://github.com/rust-hse/rust-hse-2023-<your login>.git
      

      или

      $ gh repo clone rust-hse/rust-hse-2023-<your login>
      
    • Если вы добавляли SSH ключ, то может сработать git-адрес:

      $ git clone [email protected]:rust-hse/rust-hse-2023-<your login>.git
      
  3. Каждую неделю после занятий вам надо будет обновлять репозиторий, чтобы у вас появились условия новых задач:

    $ git pull --rebase

Настройка IDE

Официально поддерживаемой средой разработки является VS Code, однако Вы вольны использовать любые редакторы/IDE, которые вам нравятся.

  1. Установите Rust, следуя официальному руководству.

  2. Установите форматтер, линтер и утилиту бенчмаркинга:

    rustup component add rustfmt
    rustup component add clippy
    cargo install cargo-criterion
    
  3. Установите VS Code.

  4. Установите расширения для VS Code:

  5. В VS Code нажмите "File" -> "Open Folder", откройте директорию, куда вы склонировали репозиторий курса.

Отправка решения

Чтобы проверить работоспособность окружения, решите первую тестовую задачу:

  1. Откройте tutorial/add/src/lib.rs. Убедитесь, что у вас работают базовые вещи: подсветка ошибок компиляции, autocomplete, go to definition.
  2. Откройте tutorial/add/tests/tests.rs. Нажмите Debug над fn it_works(), убедитесь, что тест падает и вы оказываетесь в дебагере в момент его падения.
  3. Напишите правильную реализацию функции add в tutorial/add/src/lib.rs.
  4. Установите утилиту rover для тестирования и отправки решений на сервер командой cargo install --path tools/rover (запускайте из корня репозитория).
  5. Запустите локальные тесты командой rover test, находясь в директории tutorial/add. Убедитесь, что они проходят.
  6. Отправьте своё решение на сервер командой rover submit. Ваш сабмит должен появиться по ссылке "SUBMITS" на раст-хсе.рф. После успешного прохождения тестов вам должно начислиться 0 баллов в таблице с баллами.

Если на каком-то этапе у вас возникли проблемы - пишите в чат курса.

Contributors

sprffMityaicuricserve[bot]

Issues