Coding Conventions
May 29, 2026 ยท View on GitHub
Current State
The Django project package is config, the root command entrypoint is
manage.py, and the first app package is harness_starter_kit_django.
General Rules
- Follow the style and structure of nearby project files.
- Keep root-level application entrypoints limited and intentional;
manage.pyis the established Django entrypoint. - Prefer standard Django app boundaries before adding custom framework layers.
- Keep generated, cache, database, and environment files out of version control.
Django Rules
- Keep settings, root URL configuration, ASGI, and WSGI files in
config/. - Keep app-specific code in
harness_starter_kit_django/until another app boundary is intentionally added. - Use
harness_starter_kit_djangoin imports and settings. - Keep board CRUD and comment URLs in
harness_starter_kit_django/urls.pyunder thepostsnamespace. - Keep board templates under
harness_starter_kit_django/templates/harness_starter_kit_django/. - Treat migrations as source after model changes; do not rewrite committed migrations without an explicit request.
- Use
.\.venv\Scripts\python.exe manage.py checkfor system checks. - Use
.\.venv\Scripts\python.exe manage.py testfor tests. - Document formatter, linter, and type-checker choices only after they are actually adopted.