Как написать README, по которому проект можно запустить

README объясняет, как запустить проект · docs.readme_quality

Почему это важно

README без инструкции по запуску стоит каждому новому разработчику первого дня. Достаточно требований, установки, запуска и команды тестов.

Как исправить

Что сделать: Создайте README.md с описанием проекта.

# Project Name

Краткое описание проекта.

## Требования
- Python 3.12+
- PostgreSQL 15+

## Установка
bash
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 секунд.

Публичные репозитории, которые не проходят эту проверку

Похожие проверки