Skip to content

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

Merged
edenreich merged 1 commit into
mainfrom
docs/agents-readability-guidelines
Oct 4, 2026
Merged

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

Conversation

@inference-gateway-maintainer

Copy link
Copy Markdown
Contributor

Summary

Completes the code readability guidelines in AGENTS.md, the single source of agent instructions for this repository.

Files changed

  • AGENTS.md - added the missing rule "No semicolons in documentation prose (Markdown files, doc comments): split the sentence or use a dash instead." to the existing ### Code Readability section under ## Style. The other readability rules were already present. Existing prose in AGENTS.md was reworded to drop semicolons so the file follows its own rule (no meaning changed).

CLAUDE.md reconciliation

Neither CLAUDE.md nor .claude/CLAUDE.md exists, so nothing was moved or deleted. git grep -n 'CLAUDE.md' only matches CHANGELOG.md, which is left alone.

Size

Final AGENTS.md: 53 lines, 4964 bytes (limits: under 200 lines and under 32 KiB).

Documentation only - no source code, tests, or generated code changed.

@edenreich
edenreich merged commit 839f7af into main Oct 4, 2026
@edenreich
edenreich deleted the docs/agents-readability-guidelines branch October 4, 2026 10:40
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