Skip to content

docs(agents): add code readability guidelines - #141

Merged
edenreich merged 1 commit into
mainfrom
docs/agents-readability-guidelines
Sep 26, 2026
Merged

edenreich merged 1 commit into
mainfrom
docs/agents-readability-guidelines

Conversation

@inference-gateway-maintainer

Copy link
Copy Markdown
Contributor

Summary

Makes AGENTS.md the single source of agent instructions and adds the Code Readability guidelines (as a subsection of the existing Style section).

Files changed

  • AGENTS.md - added the Code Readability rules; merged in the still-accurate content from CLAUDE.md; replaced non-ASCII dashes/arrows with ASCII.
  • CLAUDE.md - deleted (Claude Code reads AGENTS.md directly once it is gone).

Moved from CLAUDE.md into AGENTS.md

  • CI details: CI runs only black --check . and pytest tests/ (no mypy/isort); task lint scope (mypy on inference_gateway/ and examples/)
  • task generate depends on oas-download; task dev:setup; task precommit:run; what the .githooks/pre-commit hook does
  • Streaming per-backend difference (httpx with self.client.stream(...) vs requests stream=True)
  • Public exception hierarchy
  • models.py is generated by datamodel-codegen using templates/header.jinja2 and templates/pydantic/BaseModel.jinja2; new endpoints need a client.py method
  • Provider-specific metadata (thought_signature round-trip, ToolCallExtraContent / Google)
  • Streaming details: create_chat_completion_stream, [DONE] filtering, CreateChatCompletionStreamResponse validation
  • Release flow: impr:/style: patch types, manual Release workflow, version bump, changelog, v${version} tag, GitHub release, PyPI publish

Reconciled against the code: CLAUDE.md said PyPI publishing uses twine, but release.yml uses pypa/gh-action-pypi-publish, so AGENTS.md just says "publishes to PyPI". CLAUDE.md said "target 3.13"; pyproject.toml targets py312 and CI runs 3.13, so AGENTS.md says that.

AGENTS.md size

51 lines, 4843 bytes (wc -l -c AGENTS.md) - within the 200-line and 32 KiB limits.

Documentation only - no source code changed.

@edenreich
edenreich merged commit 86dfcb6 into main Sep 26, 2026
1 check passed
@edenreich
edenreich deleted the docs/agents-readability-guidelines branch September 26, 2026 17:02
inference-gateway-releaser Bot added a commit that referenced this pull request Oct 21, 2026
## [0.22.0](v0.21.1...v0.22.0) (2026-10-21)

### ✨ Features

* add deprecated include filter to model listing (sync schemas v1.4.1) ([#156](#156)) ([dc61111](dc61111))
* add WebWright provider with schemas v1.5.0 ([7fcdee3](7fcdee3))
* sync generated types with schemas v0.34.4 ([#144](#144)) ([4ac0019](4ac0019))
* sync generated types with schemas v1.2.0 ([#149](#149)) ([78d220f](78d220f))

### 👷 CI

* **deps:** bump actions/create-github-app-token ([#155](#155)) ([cc4787b](cc4787b))
* **deps:** bump actions/setup-node ([#153](#153)) ([4ae5aac](4ae5aac))

### 📚 Documentation

* **agents:** add code readability guidelines ([#141](#141)) ([86dfcb6](86dfcb6))
* **agents:** add code readability guidelines ([#148](#148)) ([839f7af](839f7af))
* handle ValidationError in chat stream example ([#150](#150)) ([d7e10e1](d7e10e1))

### 🔧 Miscellaneous

* **deps:** bump claude-code 2.1.280 -> 2.1.283 ([#142](#142)) ([37993d1](37993d1))
* **deps:** bump claude-code 2.1.283 -> 2.1.285 ([#146](#146)) ([49286f0](49286f0))
* **deps:** bump claude-code 2.1.285 -> 2.1.289 ([#151](#151)) ([57cf945](57cf945))
* **deps:** bump claude-code 2.1.289 -> 2.1.296 ([#157](#157)) ([8cc0acc](8cc0acc))
* **deps:** bump infer CLI v0.208.0 -> v0.218.0 ([#143](#143)) ([f02ecf7](f02ecf7))
* **deps:** bump infer CLI v0.218.0 -> v0.221.1 ([#145](#145)) ([f8ad720](f8ad720))
* **deps:** bump infer CLI v0.221.1 -> v0.226.0 ([#152](#152)) ([22686e1](22686e1))
* **deps:** bump infer CLI v0.226.0 -> v0.231.1 ([#158](#158)) ([ccd8c4e](ccd8c4e))
* sync generated types with schemas v1.2.2 ([#154](#154)) ([ff488ae](ff488ae))
@inference-gateway-releaser

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.22.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant