Skip to content

Commit f364133

Browse files
authored
CONTRIBUTING: describe how to create the pr to the vX.x branch (#2026)
Create a PR from a branch already rebased so that the commit list in the github UI is clean.
1 parent 711788b commit f364133

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,8 @@ If you have commit access, the process is as follows:
192192
1. Tag the commit with `git tag -s vX.Y.Z`, for example `git tag -s v1.2.3`.
193193
Copy the changelog for the release to the tag message, removing any leading `#`.
194194
1. Push tag upstream with `git push upstream --tags` (and optionally to your own fork as well)
195-
1. Open a PR from `main` to the major branch, e.g. `1.x` to update it. In order to keep history you may want to
195+
1. Open a PR from `main` to the major branch, e.g. `1.x` to update it. In order to keep history create a
196+
branch from the `main` branch, rebase it on top of the major branch to drop duplicated commits and then
196197
merge with the `rebase` strategy. It is crucial that `main` and the major branch have the same content.
197198
1. After tests pass, Github Actions will automatically build and push the new release to PyPI.
198199
1. Edit and publish the [draft Github release](https://github.com/elastic/apm-agent-python/releases)

0 commit comments

Comments
 (0)