moevm_alg_example

Общая структура проекта

Основной код программы

• Весь исходный код должен быть размещен в директории src
  • Основной файл main.* (py для Python и cpp для С/С++), содержащий основную логику программы, должен быть расположен в корне директории src
  • В случае, если в проекте имеются файлы, отличные от main.*, они должны быть размещены в поддиректории modules директории src
• Внешние зависимости/библиотеки должны быть указаны в соответствующем файле ( например, requirements.txt для Python )
• Для проектов на С/С++ в директории src должен содержаться Makefile для сборки проекта ( main - исполняемый файл основной логики программы, tests - исполняемый файл для запуска тестов )
  • Исполняемые файлы не выкладываются в репозиторий так же, как и побочные файлы сборки.

Тестирующий код

• Все тесты должны быть размещены в файле tests.* ( py для Python и cpp для С/С++ ) в директории src

Пример структуры проекта

• Пример структуры проекта

- src/
  - modules/
      - submodule1
      - submodule2
  - main
  - tests
  - [Makefile]

• Примеры проектов для C/C++ и Python приведены в репозитории.

Организация тестов

• Необходимо проводить тестирование всех основных функций/методов
• Тестирование может быть проведено с использованием простых конструкций assert или с помощью библиотек для тестирования
  • Для Python необходимо использовать pytest

Примеры организации тестов приведены в файлах tests.* соответствующих проектов.

Организация запуска проекта

Основной код

Запуск должен производиться последовательностью команд (из директории src)

# C/C++
make # или make main
./main

# Python
python3 main.py

Тестирующий код

Запуск должен производиться последовательностью команд (из директории src)

# C/C++
make # или make tests
./tests

# Python
pytest tests.py