Шаблон репозитория для выполнения домашек по курсу "Углубленное программирование на C++"

Добро пожаловать на курс!

В этом семестре для более удобной сдачи домашек мы решили сделать обязательным использование стайлчекера, линтеров и динамической проверки утечек с помощью valgrind.

Если вы раньше не работали с подобными инструментами, то впадать и истерику не стоит, для вас есть гайд по локальному запуску этих утилит

Домашки будем сдавать на github, поэтому предлагаю обговорить правила оформления:

1. Форкаем себе репозиторий и ДЕЛАЕМ ЕГО ПРИВАТНЫМ (если не получается, просто копируем себе код этого репозитория и )
2. Каждое отдельное задание выполняется в отдельной ветке, поэтому делаем git checkout -b hwN, где N - номер домашнего задания
3. Создаем папку c названием, совпадающим с названием ветки hwN
4. В папке ДЗ пишем под и добавляем Makefile и CMakeLists.txt
5. Когда задание сделано, создаем PullRequest в master (если делали форк, то обязательно в свой мастер), смотрим, что все галочки Github Actions зеленые, делаем assign на ментора и запрашиваем у него ревьью Тут хорошо бы понятно назвать PR - типа "Домашнее задание 1". Не надо называть их как "first attempt" и тому подобное
6. Когда ментор и преподаватель одобрили PR, то вмерживаем его в мастер
7. Profit

Важно:

Держим репозиторий чистым

В .gitignore есть базовый набор файлов, которых не должно быть в репозитории, но все же прошу перед отправкой домашки на проверку обратить внимание на то, что в PR нет:

• бинарей
• системных файлов (привет, маковский .DS_Store)
• файлов среды разработки (.idea, .vscode, ...)

Чтобы бинари не добавлялись в репу, в Makfile добавляйте к их окончаниям .out

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

Для понятной истории коммитов желательно описывать в них конкретно, что вы сделали

Рекомендуется также в сообщении коммита указывать номер домашнего задания, для которого коммит сделан, например git commit -m "hw1: initial commit"

Полезные ссылки:

1. Если не знаете, как удалить ветку, отменить/изменить коммит, то велком сюда
2. Пример домашки с универсальным мейкфайлом лежит в папке example

P.S.

По любым вопросам и предложениям касаемо этого репозитория пишите мне в telegram или заводите Issue на этот репозиторий, если стесняетесь, но все же лучше в личку