Skip to content

Claude: Next Iteration #495

@AkhileshNegi

Description

@AkhileshNegi

Is your feature request related to a problem?

Following up on #395 - we've adopted Claude for coding tasks and it's proving valuable. However, our CLAUDE.md lacks specific coding conventions discovered through recent code reviews, causing Claude to generate code that doesn't follow our established patterns.

Describe the solution you'd like

Update CLAUDE.md with documented best practices:

  1. Logging format - Include function name in log messages:
    logger.info(f"[function_name] Message here {mask_string(value)}.")
  2. Database comments - Add column comments in SQLModel fields:
    field_name: int = Field(
    ..., sa_column_kwargs={"comment": "Description of the column"}
    )
  3. Endpoint documentation - Use external markdown files for Swagger descriptions:
    @router.post("/path", description=load_description("domain/action.md"))
  4. Store docs in backend/app/api/docs//.md

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

Status

Closed

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions