phase1: bootstrap containerized django stack and project scaffold

This commit is contained in:
Alfredo Di Stasio
2026-03-09 16:10:34 +01:00
parent 8cd65349c8
commit 35686bdb66
32 changed files with 655 additions and 1 deletions

46
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,46 @@
# Contributing to HoopScout
## Branching Model (GitFlow Required)
- `main`: production-ready releases only
- `develop`: integration branch for completed features
- `feature/*`: feature development branches from `develop`
- `release/*`: release hardening branches from `develop`
- `hotfix/*`: urgent production fixes from `main`
## Workflow
1. Create branch from the correct base:
- `feature/*` from `develop`
- `release/*` from `develop`
- `hotfix/*` from `main`
2. Keep branch scope small and focused.
3. Open PR into the proper target branch.
4. Require passing CI checks and at least one review.
5. Squash or rebase merge according to repository policy.
## Local Development
1. `cp .env.example .env`
2. `docker compose up --build`
3. `docker compose exec web python manage.py migrate`
4. `docker compose exec web python manage.py createsuperuser`
## Testing
```bash
docker compose exec web pytest
```
## Commit Guidance
- Use clear commit messages with intent and scope.
- Avoid mixing refactors with feature behavior changes.
- Include migration files when model changes are introduced.
## Definition of Done (MVP)
- Feature works in Dockerized environment.
- Tests added/updated for behavior change.
- Documentation updated when commands, config, or workflows change.
- No secrets committed.