Skip to content

Document contribution branch convention #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucarlig merged 1 commit into from
Jul 20, 2026
Merged

Document contribution branch convention #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/book/src/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<user>/<pr-branch>`, where `<user>` is the
contributor's GitHub username and `<pr-branch>` 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:
Expand Down
Loading