Skip to content

docs: fix contributor setup instructions in AGENTS.md - #1207

Open
saikishore-p wants to merge 2 commits into
dapr:mainfrom
saikishore-p:fix/contributor-docs-dep-group
Open

saikishore-p wants to merge 2 commits into
dapr:mainfrom
saikishore-p:fix/contributor-docs-dep-group

Conversation

@saikishore-p

Copy link
Copy Markdown

Description

Two fixes to the contributor instructions in AGENTS.md.

1. The setup command can't run two of the test suites.

The setup section says:

uv sync --all-packages --group dev

and the same document later says to run:

uv run pytest tests/examples/

That combination fails. examples/langgraph-checkpointer/agent.py imports
langchain_ollama, which lives in the tests dependency group, not dev:

ModuleNotFoundError: No module named 'langchain_ollama'

CI already gets this right — both the integration and example jobs in
.github/workflows/run-tests.yaml run uv sync --frozen --all-packages --group tests.
Only the contributor docs disagree. Since tests includes dev via
{include-group = "dev"}, pointing at it costs contributors nothing.

This adds the tests group to the setup section for those two suites, and names the
requirement in the comments above the two commands that need it.

2. The pinned ruff version had drifted.

AGENTS.md states 0.14.1 in two places, while pyproject.toml pins ruff==0.15.19.
Corrected to match the pin.

Issue reference

No issue — a documentation accuracy fix, found while setting up a dev environment
for #1206.

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles correctly
  • Created/updated tests — not applicable, documentation only
  • Extended the documentation

`uv sync --all-packages --group dev` is not enough to run `tests/examples/` or
`tests/integration/`. The `tests` group carries the extra dependencies those
suites need - `examples/langgraph-checkpointer/agent.py` imports
`langchain_ollama`, which only that group installs - and it is what CI syncs for
both of those jobs (`.github/workflows/run-tests.yaml`). Following the setup
section as written, `pytest tests/examples/` fails with a ModuleNotFoundError.

Points the setup section at the `tests` group for those suites and names the
requirement in the two command comments.

Also corrects the pinned ruff version, which had drifted: AGENTS.md said 0.14.1
in two places while `pyproject.toml` pins `ruff==0.15.19`.

Signed-off-by: Sai Kishore Punagani <63619246+saikishore-p@users.noreply.github.com>
@saikishore-p
saikishore-p requested review from a team as code owners September 12, 2026 17:01

@CasperGN CasperGN left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, both fixes check out. langchain-ollama is only in the tests group, run-tests.yaml syncs --group tests for both jobs, and pyproject.toml pins ruff==0.15.19.

One change: README.md has the same gap. Its contributor steps sync --group dev (L116) and then run uv run pytest tests/integration/ and tests/examples/ (L142, L148), which fail the same way. Please apply the same fix there, so the two guides agree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants