Visitar URL original
Update AGENTS.md (incorporate review feedback) · DeepLabCut/DeepLabCut@298c12b · GitHub
Skip to content

Commit 298c12b

Browse files
committed
Update AGENTS.md (incorporate review feedback)
1 parent bcabf95 commit 298c12b

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

‎AGENTS.md‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
## DeepLabCut
44

55
DeepLabCut is a scientific Python toolbox for markerless pose estimation.
6-
Prioritize correctness, preservation of user data, and public API compatibility.
6+
Prioritize correctness, preservation of user data, backward compatibility,
7+
reproducibility, and public API compatibility.
78

8-
DeepLabCut is PyTorch-first. TensorFlow is being deprecated, but legacy support
9-
remains. Do not introduce new TensorFlow-first functionality, and preserve
10-
existing TensorFlow compatibility unless a task explicitly changes its support
11-
status.
9+
DeepLabCut is PyTorch-first. Treat PyTorch as the primary backend for new
10+
functionality. Preserve legacy TensorFlow behavior where the current support
11+
policy still requires it, but do not introduce new TensorFlow-first
12+
functionality.
1213

1314
## Guidelines
1415

@@ -18,8 +19,9 @@ status.
1819
- Treat aliases, deprecations, and default values as intentional user-facing
1920
behavior. Prefer aliases and explicit deprecation warnings over silently
2021
renaming or removing inputs.
21-
- Prefer `pathlib.Path`; do not assume POSIX paths. Isolate and document
22-
intentionally platform-specific behavior.
22+
- Prefer `pathlib.Path`; do not assume POSIX paths or that `Path.resolve()` is
23+
universally safe across filesystems. Isolate and document intentionally
24+
platform-specific behavior.
2325
- Preserve optional dependency boundaries. Do not assume that a GUI,
2426
TensorFlow, CUDA, a GPU, or a display is available.
2527
- Avoid heavy or backend-specific imports at package import time.
@@ -30,7 +32,16 @@ status.
3032
identities, and project metadata unless the task explicitly requires
3133
changing them.
3234
- Use repository tooling where available. Treat repository source, tests, and documentation as primary evidence. When they disagree, identify the inconsistency rather than silently choosing one. When available, use `llms.txt`,
33-
`knowledge/manifest.json`, `docs.jsonl`, and `api.jsonl` as discovery indexes.
35+
[published here](https://deeplabcut.github.io/DeepLabCut/llms.txt),
36+
`knowledge/manifest.json`, `docs.jsonl`, and `api.jsonl` as discovery
37+
indexes.
38+
- Prefer issue-based bookkeeping for user-visible bugs, regressions, and
39+
behavior changes when practical. Link related issues from pull requests and
40+
preserve useful reproduction details, but do not require a new issue for
41+
trivial or self-contained changes.
42+
- Keep discussion focused on code, behavior, and reproducible conditions. Do
43+
not assign fault to users, contributors, or other individuals. Describe
44+
problems neutrally and propose constructive next steps.
3445
- Update docstrings, examples, and relevant user or developer documentation
3546
when public behavior changes.
3647
- Use Google-style docstrings. Follow the surrounding documentation

0 commit comments

Comments
 (0)