Skip to content

Commit 1719aee

Browse files
committed
sync agent guidance with monorepo standards
1 parent 67e0682 commit 1719aee

2 files changed

Lines changed: 24 additions & 10 deletions

File tree

AGENTS.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ Shared instructions for coding agents working in this repository.
44

55
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.
66

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+
714
## Project Summary
815

916
This repository contains the Langfuse Python SDK.
@@ -25,6 +32,8 @@ This repository contains the Langfuse Python SDK.
2532
- Do not weaken assertions just to make tests faster or greener.
2633
- If a test is slow, first optimize setup, teardown, polling, or fixtures.
2734
- 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.
2837

2938
## Setup And Quality Commands
3039

@@ -100,12 +109,21 @@ If you change CI bootstrap:
100109
- preserve the `LANGFUSE_INIT_*` startup path for the Langfuse server unless there is a strong reason to change it
101110
- preserve `cancel-in-progress: true`
102111

103-
## Codebase Rules
112+
## Repo Rules
104113

114+
- Keep changes scoped. Avoid unrelated refactors.
105115
- Prefer `LANGFUSE_BASE_URL`; `LANGFUSE_HOST` is deprecated and is only kept for compatibility tests.
106116
- If you touch `langfuse/api/`, regenerate it from the upstream Fern/OpenAPI source instead of hand-editing files.
107117
- If you touch shutdown, flushing, or worker-thread behavior, run the relevant resource-manager and OTEL-heavy tests.
108118
- 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.
109127

110128
## Python-Specific Notes
111129

@@ -125,4 +143,8 @@ Releases are handled by GitHub Actions. Do not build an ad hoc local release flo
125143

126144
- Prefer official documentation first when answering product or API questions.
127145
- 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.
150+
- Do not revert unrelated working-tree changes.

CLAUDE.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)