From 04d01064e5e9051b756b20e87769208dda58e9d7 Mon Sep 17 00:00:00 2001 From: Christian Neukirchen Date: Tue, 23 Feb 2016 18:05:19 +0100 Subject: Rename README --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..f4e07f9 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +## git-merge-pr: apply GitHub pull requests from command-line + +## Usage + + git merge-pr [PRNUM][@REMOTE] [GIT-AM FLAGS...] + +`git merge-pr` will fetch the patch corresponding to pull request +number PRNUM of REMOTE repository (defaults to your upstream) and +applies it on top of the current tree, rewriting the commit message of +the newest patch to close the pull request upon push (can be disabled +by setting `merge-pr.autoclose` to false). + +Without PRNUM, all open pull requests of REMOTE will be listed. + +Useful `git am` flags: + +* `--signoff` +* `--3way` +* `--interactive` + +## Why rebasing pull requests is preferable to merging them + +* Keeps a linear history without merge bubbles. +* Properly keeps author and committer name as well as author and commit date. +* Conflicts can easily be dealt with in an ad-hoc fashion. +* Interactive mode allows for on-the-fly cherry picking. + +## Requirements + +* Git 2.2.0 or newer +* wget +* jq (only for listing pull requests) + +## Copyright + +git-merge-pr is in the public domain. + +To the extent possible under law, +Christian Neukirchen +has waived all copyright and related or +neighboring rights to this work. + +http://creativecommons.org/publicdomain/zero/1.0/ -- cgit 1.4.1