Writing a README that explains how to run the project
Why it matters
A README without setup steps costs every new developer their first day. Prerequisites, install, run and test commands are enough.
How to fix it
What to do: Create a
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 describing the project.# Project Namebash
Short project description.
## Requirements
- Python 3.12+
- PostgreSQL 15+
## Setup
git clone https://github.com/user/repo
cd repo
cp .env.example .env
pip install -r requirements.txt
python manage.py migrate
## Runbash
python manage.py runserver
```
Does your repository pass this check?
Free for public GitHub repositories, no account needed. 50+ DevOps and security checks in about ten seconds.