sirewix / vktgbot.hs

Simple echo bot for vk and telegram written in haskell
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

Ревью #1

Open olegromashin opened 4 years ago

olegromashin commented 4 years ago

Привет! Прошёлся по проекту, есть несколько предложений:

Когда я запускаю проект некорретно(без параметров), то нет никаких сообщений. Необходимо указать пользователю каких параметров не хватает.

В README.md сделать описание базовой структуры проекта.

Все импорты сделать или квалифицированными, или в скобках явно указать все импортируемые имена, так будет легче читать код. Даже если ты используешь только одну функцию getOptions из Options. Импортов может быть много и разбираться будет сложнее.

Hlint'ом ты вроде прошёлся, но поправил не всё.

https://github.com/wixe/vktgbot.hs/blob/master/src/Misc.hs#L17 Можно заменить на readMaybe?

https://github.com/wixe/vktgbot.hs/blob/master/src/EchoBot.hs#L90 Закоментированный код без описания причины оставлять нельзя.

Есть неочевидные имена модулей и функций. Постарайся со стороны взглянуть на все имена и избавиться от всех двусмысленностей и непонятных сокращений. Например модуль "SerDe".

Умышленно завершать программу аварийно плохо(error, fail). Все ситуации надо обрабатывать.

sirewix commented 4 years ago

Привет, @olegromashin, постарался все учесть, в частности:

Когда я запускаю проект некорретно(без параметров), то нет никаких сообщений. Необходимо указать пользователю каких параметров не хватает.

Поднял приоритет этих сообщений до Warning (приоритет логгера по умолчанию)

Умышленно завершать программу аварийно плохо(error, fail). Все ситуации надо обрабатывать.

Сделал все через ExceptT Text IO с выводом результата в лог