Skip to content

CLAUDE.md

Latest commit

 

History

History
65 lines (46 loc) · 2.78 KB

CLAUDE.md

File metadata and controls

65 lines (46 loc) · 2.78 KB
Raw

Implementation

Guidelines for writing good code for a developer:

  1. Choose clean code over clever code.
  2. Write object oriented code as much as possible.
  3. Keep function sizes small, ideally 10 lines.
  4. Try and keep files between 100 and 300 lines.
  5. Don't keep too many files in a folder or module. Try and keep it under 15.
  6. Avoid abbreviations.
  7. Use standard API as much as possible.
  8. Reuse. Write as little code as possible.
  9. Use Frappe UI, espresso design system for UI styling.
  10. Always write tests, and make sure they work.
  11. Build the minimum working app, then iterate towards your goals.
  12. Keep the verbosity less in new changes (inline comments, docstrings erc). Explain only what's absolutely needed in inline comments. Actual changes explanation can be part of commit message.

DocType

  • Use column breaks and tab breaks to create user friendly doctype forms

Dashboard data fetching

  • Prefer Frappe UI's composables — useCall, useList, useDoc, useDoctype, useNewDoc — over legacy createResource / createListResource. Migrate an old call site only when already editing that page.
  • Call whitelisted methods on the v2 path (/api/v2/method/<dotted.path>). The composables read the payload from data and never unwrap message, so /api/method/... leaves data null with no error.
  • cacheKey persists to IndexedDB and outlives a logout. Key it by user, or omit it, for anything user-specific.
  • session.login / session.logout stay on createResource.

Skills

Always load frappe-app-dev before any implementation. For UI work, also load ui-design and the building-apis skill when touching buzz/api/. (There is no frappe-ui skill — frappe-ui patterns live in frappe-app-dev's frontend references.)

Planning

For creating specs use tracer bullet approach.

Tracer bullets comes from the Pragmatic Programmer. When building systems, you want to write code that gets you feedback as quickly as possible. Tracer bullets are small slices of functionality that go through all layers of the system, allowing you to test and validate your approach early. This helps in identifying potential issues and ensures that the overall architecture is sound before investing significant time in development.

Create specs in specs/. Maintain a PROGRESS.md file to track progress of implementation phases.

Commit / PR

  • Always use conventional commits
  • Reconcile the specs after implementation
  • Do not commit spec files (specs/, PROGRESS.md) or other markdown docs (CLAUDE.md) unless explicitly asked — they are uncommitted working documents

Testing

Use agent-browser for quick manual e2e checks.

Automated e2e uses Playwright (root package.json, specs in e2e/).

Credentials

The site is buzz.localhost:8000 (Administrator/admin)