Как оформить репозиторий, чтобы его смотрели

Название

Понятное, а не остроумное. expense-tracker лучше, чем moneymaker3000. Читающий видит список из десяти репозиториев и решает по названию, что открыть.

Из названия должно быть ясно, что это. Если непонятно — добавьте короткое описание в настройках, оно показывается рядом со списком.

Что закрепить

На профиле можно закрепить несколько репозиториев наверх. Закрепите три лучших. Всё остальное уйдёт вниз и мешать не будет.

Это самое быстрое улучшение профиля: пять минут, а первое впечатление меняется полностью.

Структура

Не должно быть свалки в корне. Обычный порядок: исходники в отдельной папке, настройки отдельно, документация отдельно.

И проверьте, что в репозитории нет:

• папок с зависимостями — их не хранят, для этого есть файл со списком;
• файлов с паролями и ключами — их выносят в переменные окружения;
• служебного мусора редактора и системы;
• закомментированных кусков кода «на всякий случай».

Последнее особенно заметно: закомментированный код читается как «человек не уверен, что делает».

История изменений

Она рассказывает о вас не меньше, чем код. Что видно со стороны:

• работали регулярно или собрали всё за одну ночь;
• умеете ли разделять изменения на осмысленные части;
• пишете ли внятные сообщения.

Хорошее сообщение объясняет, что сделано: «добавил проверку суммы в форме расхода». Плохое ничего не говорит: fix, update, правки.

Переписывать старую историю не надо. Достаточно начать делать нормально с этого момента.

Мелочи, которые замечают

• Лицензия. Одна строка, но показывает, что вы понимаете, зачем она.
• Файл с примером настроек. Пустой шаблон с перечнем нужных переменных сильно упрощает запуск.
• Работающая сборка. Если настроена автоматическая проверка и она зелёная — это плюс без слов.
• Ответы в обсуждениях. Если кто-то задал вопрос, а вы ответили, это видно и производит хорошее впечатление.

Про командные репозитории

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

Отсюда простой вывод: в командном проекте лучше взять меньше, но делать самому, чем взять много и раздать. В истории останется первое.