Skip to content

new: add community-maintained extension package explanation#1665

Open
Myxogastria0808 wants to merge 4 commits intohonojs:mainfrom
Myxogastria0808:main
Open

new: add community-maintained extension package explanation#1665
Myxogastria0808 wants to merge 4 commits intohonojs:mainfrom
Myxogastria0808:main

Conversation

@Myxogastria0808
Copy link
Copy Markdown

@Myxogastria0808 Myxogastria0808 commented Dec 27, 2025

The author should do the following, if applicable

This PR adds a short section to the @hono/zod-openapi README introducing a community-maintained extension, zod-openapi-share, which helps centralize and reuse common OpenAPI response definitions.

The extension is clearly marked as non-official and is intended to complement @hono/zod-openapi in real-world API development.

  • Add tests
  • Run tests
  • yarn changeset at the top of this repo and push the changeset
  • Follow the contribution guide

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Dec 27, 2025

⚠️ No Changeset found

Latest commit: a3dfcc0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Myxogastria0808 Myxogastria0808 changed the title chore: add community-maintained extension package explanation new: add community-maintained extension package explanation Jan 25, 2026
Copilot AI review requested due to automatic review settings April 4, 2026 05:54
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation to the @hono/zod-openapi package README to point users to a community-maintained extension for sharing/reusing OpenAPI response definitions.

Changes:

  • Introduces a new “Community Extensions” section in the @hono/zod-openapi README
  • Adds a short description and links for the zod-openapi-share community package

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

### zod-openapi-share

`zod-openapi-share` is a **community-maintained** extension package for `@hono/zod-openapi` that lets you centralize and reuse response definitions across endpoints.
Normally, `@hono/zod-openapi` requires you to redefine the same responses (e.g., error schemas) for every endpoint, but with `zod-openapi-share`, you can avoid repetition and prevent definition drift, making your backend development using `hono` + `@hono/zod-openapi` cleaner and more consistent.
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In prose, "hono" is referred to elsewhere in this README as the framework name "Hono". Consider capitalizing it here for consistency (the package name can remain hono when referring to npm/install).

Suggested change
Normally, `@hono/zod-openapi` requires you to redefine the same responses (e.g., error schemas) for every endpoint, but with `zod-openapi-share`, you can avoid repetition and prevent definition drift, making your backend development using `hono` + `@hono/zod-openapi` cleaner and more consistent.
Normally, `@hono/zod-openapi` requires you to redefine the same responses (e.g., error schemas) for every endpoint, but with `zod-openapi-share`, you can avoid repetition and prevent definition drift, making your backend development using Hono + `@hono/zod-openapi` cleaner and more consistent.

Copilot uses AI. Check for mistakes.
Comment on lines +410 to +411
- GitHub: https://github.com/Myxogastria0808/zod-openapi-share
- npm: https://www.npmjs.com/package/zod-openapi-share
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These bullets use raw URLs; elsewhere in this README links are typically formatted as Markdown links (e.g., ## References uses - [Hono](https://hono.dev/) around lines 542–546). Consider switching these to Markdown link syntax for consistency/readability.

Suggested change
- GitHub: https://github.com/Myxogastria0808/zod-openapi-share
- npm: https://www.npmjs.com/package/zod-openapi-share
- GitHub: [Myxogastria0808/zod-openapi-share](https://github.com/Myxogastria0808/zod-openapi-share)
- npm: [zod-openapi-share](https://www.npmjs.com/package/zod-openapi-share)

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants