Что должно быть в хорошем README
Почему это важно
README — первое, что читают новый разработчик, пользователь и аудитор. Без него каждый вопрос идёт мейнтейнеру.
Как исправить
Что сделать: Создайте
git clone https://github.com/user/repo
cd repo
cp .env.example .env
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver
```
README.md с описанием проекта.# Project Namebash
Краткое описание проекта.
## Требования
- Python 3.12+
- PostgreSQL 15+
## Установка
git clone https://github.com/user/repo
cd repo
cp .env.example .env
pip install -r requirements.txt
python manage.py migrate
## Запускbash
python manage.py runserver
```
Проходит ли эту проверку ваш репозиторий?
Бесплатно для публичных репозиториев GitHub, без регистрации. До 58 проверок DevOps и безопасности примерно за 5 секунд.