Skip to content

Commit 8ea023e

Browse files
authored
contribution: add doc for auto-cherry-pick (#482)
1 parent 87b53fb commit 8ea023e

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,7 @@ Once we've discussed your changes and you've got your code ready, make sure that
2929
* Includes tests for new functionality.
3030
* References the original issue in description, e.g. "Resolves #123".
3131
* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
32+
33+
## How to cherry pick a merged PR?
34+
35+
See [cherry-pick.md](./docs/guides/dev/cherry-pick.md).

docs/guides/dev/cherry-pick.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Overview
2+
3+
This document explains how cherry picks are managed on release branches within all erda-projects repositories.
4+
5+
A common use case for cherry picks is backporting PRs from master to release branches.
6+
7+
## Initiate a Cherry Pick
8+
9+
- Open your **MERGED** PR page on browser
10+
11+
- Add a comment
12+
13+
This example applies a master branch PR to the release/1.0:
14+
```
15+
/cherry-pick release/1.0
16+
```
17+
18+
Tips:
19+
If you comment to an **UNMERGED** PR, erda-bot will auto append a commit to tell you: cherry-pick to an unmerged PR is
20+
forbidden.
21+
22+
## Searching for Cherry Picks
23+
24+
Filter by labels: `auto-cherry-pick`
25+
26+
Examples:
27+
28+
- [Erda auto-cherry-pick](https://github.com/erda-project/erda/pulls?q=is%3Apr+label%3Aauto-cherry-pick)

0 commit comments

Comments
 (0)