You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+24-2Lines changed: 24 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,13 @@ Shared instructions for coding agents working in this repository.
4
4
5
5
Keep this file concise, concrete, and repo-specific. If guidance grows large, split it into referenced docs instead of turning this file into a handbook.
6
6
7
+
## Maintenance Contract
8
+
9
+
-`AGENTS.md` is a living document.
10
+
- Update it in the same PR when repo-wide workflows, architecture, CI contracts, release processes, or durable coding defaults materially change.
11
+
- Do not edit this file for one-off task preferences.
12
+
- Keep this file as the canonical shared agent guide for this repository.
13
+
7
14
## Project Summary
8
15
9
16
This repository contains the Langfuse Python SDK.
@@ -25,6 +32,8 @@ This repository contains the Langfuse Python SDK.
25
32
- Do not weaken assertions just to make tests faster or greener.
26
33
- If a test is slow, first optimize setup, teardown, polling, or fixtures.
27
34
- Keep repo-shared instructions here. Keep personal or machine-specific notes out of version control.
35
+
- Keep tests independent and parallel-safe by default.
36
+
- For bug fixes, prefer writing or identifying the failing test first, confirm the failure, then implement the fix.
28
37
29
38
## Setup And Quality Commands
30
39
@@ -100,12 +109,21 @@ If you change CI bootstrap:
100
109
- preserve the `LANGFUSE_INIT_*` startup path for the Langfuse server unless there is a strong reason to change it
101
110
- preserve `cancel-in-progress: true`
102
111
103
-
## Codebase Rules
112
+
## Repo Rules
104
113
114
+
- Keep changes scoped. Avoid unrelated refactors.
105
115
- Prefer `LANGFUSE_BASE_URL`; `LANGFUSE_HOST` is deprecated and is only kept for compatibility tests.
106
116
- If you touch `langfuse/api/`, regenerate it from the upstream Fern/OpenAPI source instead of hand-editing files.
107
117
- If you touch shutdown, flushing, or worker-thread behavior, run the relevant resource-manager and OTEL-heavy tests.
108
118
- If you change OpenAI or LangChain instrumentation, keep as much coverage as possible in `tests/unit` using exporter-local assertions, and leave only the minimal necessary coverage in `tests/e2e` / `tests/live_provider`.
119
+
- Never commit secrets or credentials.
120
+
- Keep `.env.template` in sync with required local-development environment variables.
121
+
122
+
## Commit And PR Rules
123
+
124
+
- Commit messages and PR titles should follow Conventional Commits: `type(scope): description` or `type: description`.
125
+
- Keep commits focused and atomic.
126
+
- In PR descriptions, list the main verification commands you ran.
109
127
110
128
## Python-Specific Notes
111
129
@@ -125,4 +143,8 @@ Releases are handled by GitHub Actions. Do not build an ad hoc local release flo
125
143
126
144
- Prefer official documentation first when answering product or API questions.
127
145
- For OpenAI API, ChatGPT Apps SDK, or Codex questions, use the official OpenAI developer docs or Docs MCP server if available.
128
-
- If this repository keeps agent-specific files for multiple tools, treat `AGENTS.md` as the shared source of truth and import it from tool-specific files instead of duplicating instructions.
146
+
147
+
## Git Safety
148
+
149
+
- Do not use destructive git commands such as `git reset --hard` unless explicitly requested.
0 commit comments