From edeacd0d31460891d7103f52aab9fa3a9cae0677 Mon Sep 17 00:00:00 2001 From: lucarlig Date: Mon, 20 Jul 2026 15:39:09 +0100 Subject: [PATCH] Document contribution branch convention Signed-off-by: lucarlig --- docs/book/src/contributing.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/book/src/contributing.md b/docs/book/src/contributing.md index 7a124e1..d6bf4be 100644 --- a/docs/book/src/contributing.md +++ b/docs/book/src/contributing.md @@ -37,6 +37,16 @@ streaming, and telemetry attribution before they land on the hot path — see [Plugins And Policy](plugins-and-policy.md). Avoid ad hoc plugin calls in the middle of routing code. +## Branch And Pull Request Workflow + +Name contribution branches `user//`, where `` is the +contributor's GitHub username and `` is a short, kebab-case summary +of the change. For example: `user/alice/fix-session-cleanup`. + +Open pull requests as drafts while work or validation is still in progress. +Mark a pull request ready for review only after its implementation, +documentation, tests, and required checks are complete. + ## Validation The pre-commit hooks run these local gates: