aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Migrating-A-Formula-To-A-Tap.md
diff options
context:
space:
mode:
authorMike McQuaid2016-09-19 19:58:21 +0100
committerMike McQuaid2016-09-20 10:41:42 +0100
commitbd6fb88ddc72a0de4c27f65e60a82790a5d87f3f (patch)
tree4a40854293dc41c0184f5532583a864712aa5b8c /docs/Migrating-A-Formula-To-A-Tap.md
parentf87e3626bb241bc88bead4ed6448a76c1bf49f56 (diff)
downloadbrew-bd6fb88ddc72a0de4c27f65e60a82790a5d87f3f.tar.bz2
Rearrange repository files.
Diffstat (limited to 'docs/Migrating-A-Formula-To-A-Tap.md')
-rw-r--r--docs/Migrating-A-Formula-To-A-Tap.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/Migrating-A-Formula-To-A-Tap.md b/docs/Migrating-A-Formula-To-A-Tap.md
new file mode 100644
index 000000000..7bc984f84
--- /dev/null
+++ b/docs/Migrating-A-Formula-To-A-Tap.md
@@ -0,0 +1,8 @@
+# Migrating A Formula To A Tap
+There are times when we may wish to migrate a formula from one tap into another tap. To do this:
+
+1. Create a pull request to the new tap adding the formula file as-is from the original tap. Fix any test failures that may occur due to the stricter requirements for new formulae than existing formula (e.g. `brew audit --strict` must pass for that formula).
+2. Create a pull request to the original tap deleting the formula file and add it to `tap_migrations.json` with a commit message like `gv: migrating to homebrew/x11`.
+3. Put a link for each pull request in the other pull request so the maintainers can merge them both at once.
+
+Congratulations, you've moved a formula to a tap!