Skip to content

Agents: add a note for logging #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
humitos merged 1 commit into from
Oct 5, 2026
Merged

Agents: add a note for logging #334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ Always run `tox -e migrations` after adding or modifying migration files. This r
`manage.py makemigrations --check --dry-run` and catches missing or inconsistent migrations
before they cause `IntegrityError` failures at deploy time.

## Logging

- Use `structlog` keyword arguments for context, never string interpolation
- Name keys as `<model>_<field>`: `project_slug`, `build_id`, `user_username`, `organization_slug`
- Use `_id`, not `_pk`: `invitation_id=invitation.pk`
- Don't use bare keys like `project=`, `build=`, or `username=`
- Bind repeated context once with `log.bind(...)` instead of passing it to every call

## Front-end

- Most templates/css/js are in a separate repository (https://github.com/readthedocs/ext-theme/).
Loading