Skip to content

Commit b0a3916

Browse files
vishrclaude
andauthored
docs: liveness signals in README + public ROADMAP (#3002)
* docs: add liveness signals to README and a public ROADMAP - Add dynamic latest-release and last-commit badges (can't go stale) - Add positioning vs net/http and an "actively maintained" note - Add ROADMAP.md with version policy (v5 current, v4 LTS to 2026-12-31) and surface it from the README Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: fix review findings in README/ROADMAP - Correct net/http interop claim: Echo handlers are not http.Handler; interop is via WrapHandler/WrapMiddleware - Clarify binding ships with a pluggable validator (not built-in validation) - ROADMAP: reference canonical auto-HEAD issue/PR (#2895/#2949) instead of the duplicate PRs (#2944/#2937) slated for closure Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 9c748c9 commit b0a3916

2 files changed

Lines changed: 56 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Latest release](https://img.shields.io/github/v/release/labstack/echo?style=flat-square&label=release&color=00afd1)](https://github.com/labstack/echo/releases)
2+
[![Last commit](https://img.shields.io/github/last-commit/labstack/echo/master?style=flat-square)](https://github.com/labstack/echo/commits/master)
13
[![Sourcegraph](https://sourcegraph.com/github.com/labstack/echo/-/badge.svg?style=flat-square)](https://sourcegraph.com/github.com/labstack/echo?badge)
24
[![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://pkg.go.dev/github.com/labstack/echo/v5)
35
[![Go Report Card](https://goreportcard.com/badge/github.com/labstack/echo?style=flat-square)](https://goreportcard.com/report/github.com/labstack/echo)
@@ -11,6 +13,8 @@
1113

1214
High performance, extensible, minimalist Go web framework.
1315

16+
Echo is built on Go's standard `net/http` — and interoperates with it via `echo.WrapHandler` / `echo.WrapMiddleware` — adding the parts the standard library leaves to you: a fast radix-tree router, request binding (with a pluggable validator), a deep middleware ecosystem, and centralized error handling. Actively maintained, with `v5` as the current release line (see badges above for the latest version and most recent commit).
17+
1418
* [Official website](https://echo.labstack.com)
1519
* [Quick start](https://echo.labstack.com/docs/quick-start)
1620
* [Middlewares](https://echo.labstack.com/docs/category/middleware)
@@ -53,6 +57,8 @@ Click [here](https://github.com/sponsors/labstack) for more information on spons
5357
- See [API_CHANGES_V5.md](./API_CHANGES_V5.md) for public API changes between `v4` and `v5`, notes on upgrading.
5458
- Echo `v4` is supported with **security*** updates and **bug** fixes until **2026-12-31**
5559

60+
See [ROADMAP.md](./ROADMAP.md) for where Echo is heading and the version support policy.
61+
5662
### Installation
5763

5864
```sh

ROADMAP.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Echo Roadmap
2+
3+
> **DRAFT** — this is a starting point for maintainers to edit, not a commitment.
4+
> Dates and priorities are owned by the Echo team. Open a discussion to propose changes.
5+
6+
This document exists so the community can see where Echo is heading. Echo is
7+
**actively maintained**. We publish releases regularly across two supported
8+
lines — see [README](./README.md) badges for the latest version and most recent commit.
9+
10+
## Version policy
11+
12+
| Line | Status | Support |
13+
|------|--------|---------|
14+
| `v5` | **Current** (since 2026-01-18) | New features, fixes, and improvements. |
15+
| `v4` | Maintenance / LTS | **Security and bug fixes until 2026-12-31.** No new features. |
16+
17+
Upgrading from v4? See [API_CHANGES_V5.md](./API_CHANGES_V5.md).
18+
19+
Echo supports the **latest four Go major releases** and may work with older versions.
20+
21+
## Now (in progress)
22+
23+
- Stabilizing the `v5` API surface through point releases.
24+
- Documentation catch-up for v5 behavior changes (e.g. CORS / `RouteNotFound`
25+
behavior on groups — see #2950).
26+
- Triaging and reducing the open issue / PR backlog.
27+
28+
## Next (under consideration)
29+
30+
These are frequently-requested items being discussed. Inclusion here is **not** a
31+
commitment — each still needs design agreement before implementation:
32+
33+
- **Automatic `HEAD` for `GET` routes** (#2895; see #2949) — opt-in, likely via an
34+
`OnAddRoute` hook so users keep control.
35+
- **Rate limiter response metadata** — expose `Retry-After` / remaining quota
36+
through the store interface (#2961).
37+
- **Real-IP / `Forwarded` header handling** improvements (#2744).
38+
- **Proxy middleware** authorization-header handling (#2787).
39+
40+
## Later / exploratory
41+
42+
- Continued alignment with the Go standard library (`net/http`, `slog`).
43+
- Reducing third-party surface where the stdlib now covers the need.
44+
45+
## How to influence the roadmap
46+
47+
- **Discuss before large PRs** — open a [Discussion](https://github.com/labstack/echo/discussions)
48+
or issue so we can agree on the design first.
49+
- 👍 reactions on issues help us gauge demand.
50+
- See [README → Contribute](./README.md#contribute) for contribution guidelines.

0 commit comments

Comments
 (0)