Enhance static files management guidelines: clarify directory structure, file management rules, and benefits of separation for better adherence to Django best practices

This commit is contained in:
pacnpal
2025-02-23 12:09:18 -05:00
parent dd8ac02525
commit a2461f5382
2 changed files with 31 additions and 1 deletions

View File

@@ -27,4 +27,17 @@ This applies to all management commands including but not limited to:
- Creating superuser: `uv run manage.py createsuperuser`
- Starting shell: `uv run manage.py shell`
NEVER use `python manage.py` or `uv run python manage.py`. Always use `uv run manage.py` directly.
NEVER use `python manage.py` or `uv run python manage.py`. Always use `uv run manage.py` directly.
## Static Files Management
IMPORTANT: All static files must be placed in the `static/` directory, not `staticfiles/`. The `staticfiles/` directory is reserved for Django's collectstatic command output and should not be used directly.
This consolidation:
1. Follows Django best practices of separating source static files from collected files
2. Prevents confusion between development and production static file locations
3. Makes it clear which static files are part of the source code (static/) versus compiled/collected (staticfiles/)
When adding new static files:
- Add them to `static/` directory
- Use Django's `static` template tag to reference them
- Run `uv run manage.py collectstatic` when deploying