Enforce PR descriptions

Agents
1

I’m subscribed to the release emails to try be up to date, but it’s hard (or not as trivial/quick as could be nowadays) to follow what a PR is about with just its title. Many PRs don’t have a description, so one has to look at the code and figure what was added in there.

I’m not asking for livekit-docs to be updated together with the PR (which would be ideal), but at least enforcing that all PRs have a description / link to an issue that explains what’s solved and high level how :folded_hands:

As an example, we have a GH action checking for PR titles to follow conventions, so I’m sure something similar could enforce a non-empty PR description.

2

@Marc_Torrellas_Socastro

Completely agree. Following via release emails and PR titles alone makes it hard to understand intent without diving into the diff.

A GitHub Action that blocks merge on an empty PR body is straightforward to add, similar to the title convention check you already have. Even a one-line description or a linked issue would make a big difference for contributors tracking changes.

3

Which emails are you subscribed to? Which PRs do you follow?

This is what I tend to look at but there can be a LOT in each release as the team is moving fast:

4

I guess that as an email, but it’s pretty much the same. Today I was reviewing many releases since March. Maybe this has improved in the recent months since for the one you linked only feat(worker): send deployment environment in worker registration by theomonnom · Pull Request #5920 · livekit/agents · GitHub or feat(models): update model literals for LLM, STT, and TTS, adding new models and options by russellmartin-livekit · Pull Request #5917 · livekit/agents · GitHub have no PR description (I didn’t check them all)

For older ones, it was more frustrating because the title wouldn’t be always enough

5

Glad to hear it is getting better.