fedochet / csc-java-2020

Сборка

Для сборки проекта используется Maven.
Его можно уставновить с помощью пакетного менеджера (apt-get, brew) или скачать тут.

Сниппеты для сборки

# полная сборка проекта
mvn clean compile test checkstyle:checkstyle

# можно собрать отдельную задачу изолированно
cd task03.rle && mvn clean test

# сборка без тестов
mvn clean compile

# также можно запустить чекстайл без сборки
mvn checkstyle:checkstyle

Maven и Intellij IDEA

При импорте проекта IDE распознает maven и самостоятельно разметит директории.
Если вдруг этого не произойдет, это можно сделать через интерфейс (вкладка Maven на правой боковой панели) или текстовый поиск по команде "Reimport all Maven projects" (shift + shift для начала поиска)

Тесты

Для тестов используется JUnit4. Несколько примеров можно найти в классе ExampleTest (внутри задачи 2).
Запускать и дебажить тесты можно из IDE - после импорта проекта слева от тестов отрисовываются кнопки для быстрого запуска.

Как уже было сказано, самостоятельное написание студентом тестов для задачи поощряется баллами.

Checkstyle

В проект включены чекстайл-проверки, чтобы было проще научиться правильно форматировать код.
checkstyle можно запустить из командной строк (см. пример выше или из вкладки Maven в IDE).
Посылаемая на проверку задача должна проходить checkstyle-проверку.

Структура модулей с задачами

Каждая задача представлена отдельным модулем.
При решении задач следует придерживаться maven-конвенции внутри модулей:

src
|- main
|  |- java      # классы с решением
|  |- resources # ресурсы для решения
|- test 
|  |- java      # классы с тестами 
|  |- resources # ресурсы для тестов

Все классы (основные и тестовые) задачи должны иметь общий package:

org.csc.nsk.java2020.<task_name>

Сдача задания

Решение задачи необходимо делать в отдельной git-ветке внутри форкнутого репозитория.
Для читаемости ветку лучше называть <student_name>/task-##-<task_name>
Посылка задачи - это пуллреквест из ветки задачи в master.