Skip to content

Consider standardizing on more detailed commit messages #10891

@mpuncel

Description

@mpuncel

As an end user who is not involved day-to-day in Envoy development, I only occasionally need to look at Envoy source code or commit history. Detailed commit messages can help people like me get context on the rapid changes occurring between updates more quickly.

As an example, I was looking into the details of how the max_connections circuit breaker is implemented. In particular, I wanted to know what happens if the runtime circuit breaker value is set lower than the current number of connections.

I noticed that there is both source/common/http/conn_pool_base.cc and source/common/http/http1/conn_pool_legacy.cc to look at, so I searched for the commit where conn_pool_legacy.cc was introduced but the commit message only showed Combine H1 and H2 conn_pool implementations (#9668). While this gives me a bit of a trail to follow to PR and issue, it feels like that would be a good place to explain something like "the old connection pool implementations remain behind runtime flags so they can be switched to in an emergency".

Just food for thought, as a beneficiary I very much appreciate all of the work being done all the time, it just can be a bit hard to keep up with at times.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions