Skip to content

Commit 948a4ac

Browse files
committed
update readme
1 parent 86b79db commit 948a4ac

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ gh ext upgrade combine
3434

3535
## Usage 🚀
3636

37+
Before we get into the usage, there are a few key concepts to understand:
38+
39+
- **Combining**: This is the process of taking multiple pull requests and combining them into one. This is done by creating a new pull request that contains the changes from all the combined pull requests.
40+
- **Filtering**: If you run this CLI with no flags, it will attempt to combine all open pull requests in the repository. This is not always what you want. You can use the various flags to filter the pull requests that are combined. For example, you can filter by label, branch name, etc. See the `--help` output for more information on the available flags.
41+
42+
It is also important to understand what the output looks like. By default, the output is a table that shows the following information:
43+
44+
- Shows the repos that were operated on
45+
- Shows the number of pull requests that were combined per repo
46+
- Shows the number of total _combined_ pull requests that were created
47+
- Shows the number of pull requests that were **skipped** (not combined)
48+
- **MC**: Merge Conflict - Means that the pull request could not be merged into the combined pull request due to a merge conflict
49+
- **DNM**: Did not Match - Means that the pull request did not match the filters (criteria) that were applied
50+
3751
### Demo 📹
3852

3953
https://github.com/user-attachments/assets/e993e282-5182-4599-aca8-531a80ec124f

0 commit comments

Comments
 (0)