docs(contributing): add Conventional Commits and Branches section#208
Open
yassin-berriai wants to merge 1 commit into
Open
docs(contributing): add Conventional Commits and Branches section#208yassin-berriai wants to merge 1 commit into
yassin-berriai wants to merge 1 commit into
Conversation
Documents the two community specs that BerriAI/litellm#28703 introduces git hooks and a CI check for: - Conventional Commits 1.0.0 — commit / PR-title format, allowed types, the lowercase-leading-description rule, and breaking-change syntax. - Conventional Branches — branch format, allowed types, and the protected-branch bypass list (main, litellm_internal_staging, dependabot/*, gh-readonly-queue/*). - How to install the opt-in hooks via 'make install-hooks' and the --no-verify escape hatch. CONTRIBUTING.md in the main repo now points here instead of duplicating the content. Companion to BerriAI/litellm#28703. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
yassin-berriai
pushed a commit
to BerriAI/litellm
that referenced
this pull request
May 23, 2026
Resolves two findings from the automated code review: 1. CONTRIBUTING.md: shrink the new Conventional Commits / Branches section to a 2-line pointer at docs.litellm.ai. Per the team convention, the full documentation lives in the litellm-docs repo — see BerriAI/litellm-docs#208 for the companion change that adds the section to docs/extras/contributing_code.md. 2. .githooks/commit-msg: tighten the subject regex to also reject an uppercase first letter in the description. CI's subjectPattern is ^(?![A-Z]).+$ so the previous local hook would accept 'feat: Add thing' which would then fail the PR-title check. The local hook is now the strictly tighter of the two gates. Test cases extended to cover both the new rejection and the digit/symbol-start cases that remain allowed. Resolves LIT-3306 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a new Commit and Branch Conventions section to
docs/extras/contributing_code.mdcovering:!).feature | bugfix | hotfix | release | chore), and the protected-branch bypass list (main,litellm_internal_staging,dependabot/*,gh-readonly-queue/*).make install-hooksand the--no-verifyescape hatch.The checklist at the top of the page also gains a "Follow the Commit and Branch Conventions" item.
Why
Companion to BerriAI/litellm#28703, which introduces:
.githooks/commit-msgand.githooks/pre-push(opt-in)make install-hookstargetPer the team convention, the detailed documentation lives in this repo rather than in
CONTRIBUTING.mdof the main repo.CONTRIBUTING.mdin the main repo links here.Preview
The new section sits between "Contributor License Agreement (CLA)" and "Proxy (Backend)", with this outline: