Skip to content

feat: add CLAUDE.md for LLM-assisted development guidance #23945

@laipz8200

Description

@laipz8200

1. Is this request related to a challenge you're experiencing? Tell me about your story.

Using LLMs for coding is becoming the norm. The Dify team hopes to share our development principles with those using LLMs by adding a CLAUDE.md file to the project, helping everyone write code with consistent style.

Currently, when developers use AI coding assistants like Claude Code, Cursor, or GitHub Copilot in our codebase, they lack specific guidance about our project's unique requirements, such as using uv run --project api for Python commands, our testing practices, and code style conventions.

2. Additional context or comments

Although we only provide CLAUDE.md, developers who don't use Claude Code can associate this file with AGENT.md or other configuration files for their preferred AI tools.

The CLAUDE.md file provides:

  • Essential development commands for backend and frontend
  • Testing guidelines and code style requirements
  • Important notes about our development workflow
  • Common development task examples

This helps AI assistants generate code that follows our project conventions from the start, reducing review cycles.

3. Can you help us with this feature?

  • I am interested in contributing to this feature.

Metadata

Metadata

Assignees

Labels

📚 documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions