На главную
Контейнеры и CI/CD
Генератор README
Из полей проекта собирает README.md: бейджи, оглавление со ссылками на разделы, таблицы команд и переменных окружения.
Проект
Разделы
Бейджи и оглавление
README.md
Заполните хотя бы название проекта.
Что обычно забывают
- · Первый абзац отвечает на вопрос «что это и зачем», а не «как установить». Его читают из поиска.
- · Блок установки должен работать копипастой: без «см. документацию» и без переменных, которых нет в тексте.
- · Якоря оглавления GitHub строит по заголовку: строчные буквы, пробелы в дефисы, знаки препинания выброшены. Здесь они уже посчитаны так же.
- · Раздел про переменные окружения избавляет от половины вопросов в issues.