You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1b3dd5a
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: AGENTS.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,6 +102,21 @@ template). Never hardcode or commit API keys.
102
102
- Use Conventional Commit messages (`feat:`, `fix:`, `docs:`, ...).
103
103
release-please parses them to generate versions and CHANGELOG.md; a wrong
104
104
prefix causes a wrong release bump. Never edit CHANGELOG.md by hand.
105
+
-**Several changes in one PR**: a squash merge keeps only the PR title, so
106
+
release-please would list one entry. When a PR contains several changes that
107
+
belong in the changelog separately (for example several bug fixes), add a
108
+
commit override block at the end of the PR description, one Conventional
109
+
Commit per line. release-please uses these lines instead of the PR title:
110
+
111
+
```
112
+
BEGIN_COMMIT_OVERRIDE
113
+
fix(clustering): describe the first fix
114
+
fix(widgets): describe the second fix
115
+
END_COMMIT_OVERRIDE
116
+
```
117
+
118
+
The PR title still has to be a valid Conventional Commit. Each line counts
119
+
for the version bump, so a `feat:` or `!` line bumps accordingly.
105
120
- Every behavior change needs a unit test in the affected module.
106
121
- All pull requests are to be created as drafts (`gh pr create --draft`) until authorization is explicitly given to mark them ready for review. Always inform the user that the PR was created as a draft.
107
122
- Run the module's tests and `lint` before declaring work done, and report
0 commit comments