Как нужно и как не нужно делать

Здесь находятся практики и примеры того, как нужно делать и как не нужно. От мелких вещей, до довольно серьёзных.

Как правильно прикладывать логи

Неправильно

Правильно

Лог при попытке запустить проект:

Детали

src/index.ts:1:21 - error TS2307: Cannot find module 'fastify' or its corresponding type declarations.

1 import Fastify from 'fastify';
~~~~~~~~~
Found 1 error.

Пример думаю можно прямо в документ положить

Ну и, разумеется, оформи как считаешь нужным, если что могу доп. пояснения дать почему это так необходимо

Совет

• Лог нужно помещать в тег <details></details>, так намного проще ознакамливаться с содержимым
• Сам лог нужно форматировать. Можно помещать в тег ```log<лог>`. Одинарные бэктики лучше не использовать т.к. содержимое лога может испортить форматирование