Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

chore(api): add union-type and default-param rules to AGENTS.md (#42652)

Streamad7849a82b9a
diff --git a/api/AGENTS.md b/api/AGENTS.md
index ac77301f8dd..160ae644a28 100644
--- a/api/AGENTS.md
+++ b/api/AGENTS.md
@@ -23,3 +23,8 @@ Run direct Python commands through `uv run --project api`. Docker-backed integra
- Use Pydantic v2 for request and response models. Reuse domain-specific exceptions and translate them at the controller boundary.
- Use existing Celery task and queue owners for asynchronous work; do not route unrelated jobs through workflow-specific services.
- Celery tasks that may be retried or redelivered must keep side effects idempotent and log affected resource identifiers.
+
+## Typing Best Practises
+
+- Treat nullable types (`T | None`) strictly as union types; document the semantic meaning for each branch.
+- Treat default parameter values as introducing distinct function overloads; verify that every added default has demonstrable practical utility and avoids masking unsafe runtime states.