From f0851e40ce89b677f2729c3322ce6e5d232d4d36 Mon Sep 17 00:00:00 2001
From: Andrey Lushnikov <lushnikov@chromium.org>
Date: Fri, 22 Nov 2019 18:48:38 -0800
Subject: [PATCH] docs(devops): contributing browser patches

---
 browser_patches/contributing.md | 64 +++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 browser_patches/contributing.md

diff --git a/browser_patches/contributing.md b/browser_patches/contributing.md
new file mode 100644
index 0000000000..d5359af664
--- /dev/null
+++ b/browser_patches/contributing.md
@@ -0,0 +1,64 @@
+# Contributing Browser Patches
+
+Firefox and WebKit have additional patches atop to expose necessary capabilities.
+
+Ideally, all these changes should be upstreamed.
+For the time being, it is possible to setup a browser checkout
+and develop from there.
+
+## 1. Setting up local browser checkout
+
+From the `playwright` repo, run the following command:
+
+```sh
+$ ./browser_patches/prepare_checkout.sh firefox
+```
+
+(you can optionally pass "webkit" for a webkit checkout)
+
+> **NOTE:** this command downloads GBs of data.
+
+This command will:
+- create a git browser checkout at `./browser_patches/firefox/checkout`
+- create a `browser_upstream` remote in the checkout
+- create a `playwright-build` branch and apply all playwright-required patches to it.
+
+## 2. Developing a new change
+
+You want to create a new branch off the `playwright-build` branch.
+
+Assuming that you're under `./browser_patches/firefox/checkout`:
+
+```sh
+$ git checkout -b my-new-feature playwright-build
+$ # develop my feature on the my-new-feature branch ....
+```
+
+## 3. Exporting your change to playwright repo
+
+Once you're happy with the work you did in the browser-land, you want to export it to the `playwright` repo.
+
+Assuming that you're in the root of the `playwright` repo and that your browser checkout has your feature branch checked out:
+
+```sh
+$ ./browser_patches/export.sh firefox
+```
+
+This script will:
+- create a new patch and put it to the `./browser_patches/firefox/patches/`
+- update the `./browser_patches/firefox/UPSTREAM_CONFIG.sh` if necessary
+- bump the `./browser_patches/firefox/BUILD_NUMBER` number.
+
+Send a PR to the PlayWright repo to be reviewed. 
+
+## 4. Rolling PlayWright to the new browser build
+
+Once the patch has been committed, the build bots will kick in, compile and upload a new browser version to all the platforms.
+
+You can check the CDN status:
+
+```sh
+$ ./browser_patches/tools/check_cdn.sh
+```
+
+As the builds appear, you can roll to a new browser version in the `./package.json` file.
\ No newline at end of file