Skip to content

docs: reuse Makefile targets in CI and simplify AGENTS.md - #3825

Merged
FBruzzesi merged 7 commits into
narwhals-dev:docs/AGENTS-mdfrom
EdAbati:docs/agents-md-edo
Jul 30, 2026
Merged

docs: reuse Makefile targets in CI and simplify AGENTS.md#3825
FBruzzesi merged 7 commits into
narwhals-dev:docs/AGENTS-mdfrom
EdAbati:docs/agents-md-edo

Conversation

@EdAbati

@EdAbati EdAbati commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Description

We can move some commands to the Makefile to make it easier for human and agents to run them

see in-line comments for more details :)

This PR is to your #3821 branch @FBruzzesi

What type of PR is this? (check all applicable)

  • 💾 Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • 🔧 Optimization
  • 📝 Documentation
  • ✅ Test
  • 🐳 Other

Related issues

  • Related issue #<issue number>
  • Closes #<issue number>

AI assistance

  • No AI tools were used for this PR.
  • AI tools were used.

Checklist

  • Code follows style guide (ruff)

  • Tests added

  • Documented the changes

  • If this is your first PR to narwhals, attach a screenshot of pytest passing locally (not CI):

    PYTEST_ADDOPTS="--numprocesses=logical" \
    make run-ci DEPS="--extra pandas --extra dask --group core-tests --group sklearn --group plugins" \
    CMD="pytest tests --cov=src --cov=tests --runslow --constructors=pandas,pandas[nullable],pandas[pyarrow],pyarrow,polars[eager],polars[lazy],dask,duckdb,sqlframe"

@EdAbati
EdAbati requested a review from FBruzzesi July 30, 2026 06:17
Comment thread AGENTS.md
that catches missing `# pragma: no cover`):

```bash
PYTEST_ADDOPTS="--numprocesses=logical" make run-ci DEPS="--extra pandas --extra dask --group core-tests --group sklearn --group plugins" CMD="pytest tests --cov=src --cov=tests --cov-fail-under=100 --runslow --durations=30 --constructors=pandas,pandas[nullable],pandas[pyarrow],pyarrow,polars[eager],polars[lazy],dask,duckdb,sqlframe"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

this was a bit too long for the agent IMO

Comment thread CONTRIBUTING.md
- Install prek as a git hook: `uv run prek install`
- To run tests: `uv run pytest`
- To run all linting checks: `make lint`
- To run ruff formatting and linting: `make lint`

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

technically make lint does NOT "run all linting checks" :)

Comment thread Makefile
.PHONY: docs-build
docs-build: ## Build the docs locally
uv run --group docs zensical build --clean
.PHONY: docs-dynamic-content

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

to make it reusable

@FBruzzesi FBruzzesi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @EdAbati 🙏🏼 I left a tiny suggestion (nitpicking on a style preference)

Comment thread Makefile
Comment thread Makefile Outdated
EdAbati and others added 2 commits July 30, 2026 12:11
Co-authored-by: Francesco Bruzzesi <42817048+FBruzzesi@users.noreply.github.com>
Co-authored-by: Francesco Bruzzesi <42817048+FBruzzesi@users.noreply.github.com>
@FBruzzesi
FBruzzesi merged commit 5735064 into narwhals-dev:docs/AGENTS-md Jul 30, 2026
12 of 14 checks passed
@EdAbati
EdAbati deleted the docs/agents-md-edo branch July 30, 2026 12:19
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