33 lines (25 loc) · 1.4 KB

AGENTS.md

This file provides guidance for Codex (and other AI agents) working in this repository. Its scope covers the entire repo.

For repository-wide policies and detailed workflows (including releases and changelogs), defer to the canonical guidance in CONTRIBUTING.md.

Quickstart

Install dependencies with uv sync.
Install Git hooks: pre-commit install.
Use make format before committing to format both backend and frontend code.

Running the project

For local frontend development, set _RELEASE = False in streamlit_webrtc/component.py (do not commit this change) and run:
- cd streamlit_webrtc/frontend && pnpm dev
- In another terminal: streamlit run home.py

Testing

Backend tests: uv run pytest
Frontend tests: cd streamlit_webrtc/frontend && pnpm test

Type checking

Run uv run mypy . for backend typing.

Building

Full build: make build
Frontend-only build: cd streamlit_webrtc/frontend && pnpm run build

Release notes

Create a changelog fragment with scriv create for each PR (scriv create --edit to open an editor) and commit it under changelog.d/.
CI will open a changelog preview PR from committed fragments; maintainers merge it before the automated release build runs.

Contribution notes

Keep changes minimal and focused; prefer small, reviewable commits.
Follow existing code patterns and naming conventions in each area.