Есть пример как оформить репозиторий для портфолио?

Question

[ReyGrau]

Есть пример как правильно оформить репозиторий для портфолио, скрин приложения там прикрепить, нужно ли описывать что использовалось и т.д.?

Comments

[Дмитрий]

Чем больше тем лучше, опишите, доку сделайте, скрины, примеры, бэйджики, тесты...

[ReyGrau]

Дмитрий, Что такое бейджики?

[Дмитрий]

ReyGrau, https://github.com/badges/shields

[DevMan]

ReyGrau, а зачем это вообще?
ценность публичного кода весьма переоценена. в первую очередь благодаря ушлым ребятишкам.

[ReyGrau]

Дмитрий, Понял, спасибо

Answer 1

[Василий Банников]

1. Сделай в репе всё что можешь сделать. Тоесть например тесты, настроенный ci/cd, и прочее такое.
Бейджики, что тесты прошли/не прошли
2. Полностью опиши проект, что это такое, и как его у себя задеплоить. В идеале какой-нибудь автоматизированный скрипт (например через Docker)
3. Добавь скрины и ссылку на демку, если это возможно.
4. Если проект сложный, то напиши документацию о том, что и где там есть.
5. Естественно, опиши в отдельном разделе все используемые технологии, и для чего они использовались.

Comments

[ReyGrau]

Окей, спасибо

Answer 2

[Saboteur]

Оформлять репозиторий как портфолио не имеет смысла.
Или вы в принципе ведете какие-то хобби проекты, и храните их в публичном репозитории типа гитхаба - в этом случае вы и сами причешете репозиторий, всякие readme там добавите просто чтобы было понятно что это и зачем.

А кидать туда тестовые вещи, которые вы специально для интервью наделали - ну это такое...

Comments

[Strannyk]

Можно накидать ранее выполненные тестовые задания, которые делали "как себе". Чтобы потом туда посылать всех остальных, предлагающих выполнить тестовое.