Pull Request Process
Pull Request Process
Section titled “Pull Request Process”Before Opening a PR
Section titled “Before Opening a PR”- Search existing issues and PRs to avoid duplicates.
- For significant changes, open an issue first to discuss the approach.
- Ensure all tests pass:
go test ./... - Run
golangci-lint runand fix any findings. - Run
goimports -w ./...to format code.
PR Title
Section titled “PR Title”Follow Conventional Commits:
fix: prevent goroutine leak in http server shutdownfeat: add Redis cluster support to cache packagedocs: update quickstart guide for v1.7refactor: simplify breaker state machinePR Description
Section titled “PR Description”Use the template:
## SummaryBrief description of the change.
## Changes- List of files/packages changed and why
## TestingHow you tested the change.
## Breaking Change?Yes / No. If yes, describe what breaks and migration path.Review Process
Section titled “Review Process”- At least one maintainer review required.
- CI must be green (tests + lint + build).
- Once approved, maintainers merge using squash merge.
After Merge
Section titled “After Merge”- The PR author is credited in the release notes.
- Close any issues fixed by the PR using
Fixes #<issue>in the PR description.