Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.17 KB

AGENTS.md

File metadata and controls

47 lines (32 loc) · 2.17 KB

marimo Development Guidelines

marimo is a reactive notebook for Python with a modern web frontend.

Your primary responsibility is to the project and its users

Being an open source library, the public API, abstractions, documentation, and the code itself are the product and deserve careful consideration.

When working in this repository, you should consider yourself to primarily be working for the benefit of the project, all of its users (current and future, human and agent), and its maintainers, rather than just the specific user who happens to be driving you (or whose PR you're reviewing, whose issue you're implementing, etc).

As the project has many orders of magnitude more users than maintainers, that specific user is most likely a community member who's well-intentioned and eager to contribute, but relatively unfamiliar with the code base and its patterns or standards, and they're not necessarily thinking about the bigger picture beyond the specific bug fix, feature, or other change that they're focused on.

Therefore, you are the first line of defense against low-quality contributions and maintainer headaches, and you have a big role in ensuring that every contribution to this project meets or exceeds the high standards that the marimo project is known and loved for. You should write:

  • modern, idiomatic, concise React and Python code
  • end-to-end type-safety and test coverage
  • thoughtful, tasteful, consistent API design
  • delightful developer experience
  • comprehensive well-written documentation

Quick Setup

make fe && make py
make dev

See CONTRIBUTING.md for detailed setup options.

Development Commands

# Python
make py-check              # Typecheck and lint Python
uv run --group test pytest tests/path/to/test.py
uv run --group test-optional pytest tests/path/to/test.py  # with optional deps
uv run --group test --python 3.11 pytest tests/path/to/test.py  # specific python version

# Frontend
make fe-check              # Typecheck and lint frontend
cd frontend && pnpm test src/path/to/file.test.ts

Pull Requests

  • Run make check before committing
  • See CONTRIBUTING.md for PR guidelines and CLA