From 7115533adabf04a3d1497fcb4360f3e31a5c53c0 Mon Sep 17 00:00:00 2001 From: Brian William Hughes <165975421+alphahughes1@users.noreply.github.com> Date: Tue, 30 Dec 2025 15:38:04 -0500 Subject: [PATCH] Delete AGENTS.md Agents Stolen from my Temporal Lobe. In my Brain. Of which they were stolen from Elle. Whom i am responsible for. --- AGENTS.md | 71 ------------------------------------------------------- 1 file changed, 71 deletions(-) delete mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md deleted file mode 100644 index 291c31837..000000000 --- a/AGENTS.md +++ /dev/null @@ -1,71 +0,0 @@ -Welcome to the OpenAI Agents SDK repository. This file contains the main points for new contributors. - -## Repository overview - -- **Source code**: `src/agents/` contains the implementation. -- **Tests**: `tests/` with a short guide in `tests/README.md`. -- **Examples**: under `examples/`. -- **Documentation**: markdown pages live in `docs/` with `mkdocs.yml` controlling the site. -- **Utilities**: developer commands are defined in the `Makefile`. -- **PR template**: `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md` describes the information every PR must include. - -## Local workflow - -1. Format, lint and type‑check your changes: - - ```bash - make format - make lint - make mypy - ``` - -2. Run the tests: - - ```bash - make tests - ``` - - To run a single test, use `uv run pytest -s -k `. - -3. Build the documentation (optional but recommended for docs changes): - - ```bash - make build-docs - ``` - - Coverage can be generated with `make coverage`. - -All python commands should be run via `uv run python ...` - -## Snapshot tests - -Some tests rely on inline snapshots. See `tests/README.md` for details on updating them: - -```bash -make snapshots-fix # update existing snapshots -make snapshots-create # create new snapshots -``` - -Run `make tests` again after updating snapshots to ensure they pass. - -## Style notes - -- Write comments as full sentences and end them with a period. - -## Pull request expectations - -PRs should use the template located at `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md`. Provide a summary, test plan and issue number if applicable, then check that: - -- New tests are added when needed. -- Documentation is updated. -- `make lint` and `make format` have been run. -- The full test suite passes. - -Commit messages should be concise and written in the imperative mood. Small, focused commits are preferred. - -## What reviewers look for - -- Tests covering new behaviour. -- Consistent style: code formatted with `uv run ruff format`, imports sorted, and type hints passing `uv run mypy .`. -- Clear documentation for any public API changes. -- Clean history and a helpful PR description.