summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYannis Guyon <yguyon@google.com>2023-04-07 15:10:16 +0200
committerYannis Guyon <yguyon@google.com>2023-04-07 15:10:16 +0200
commit4b7d7b4f2ba53f2bde0d0f4f4ec9c2fbbb7c3f53 (patch)
tree417a950857945a4fdd48b25354b96d8688ab3180
parent349f4353dd638f2f85e7dd2d9df9a68f54d9919c (diff)
downloadlibwebp-4b7d7b4f2ba53f2bde0d0f4f4ec9c2fbbb7c3f53.tar.gz
Add contribution instructions
Change-Id: Icc58ef6c1e79e59977e0093973ad353237560e8e
-rw-r--r--CONTRIBUTING.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7a73a303..330b38f6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,7 +19,44 @@ again.
All submissions, including submissions by project members, require review. We
use a [Gerrit](https://www.gerritcodereview.com) instance hosted at
-https://chromium-review.googlesource.com for this purpose. See the
+https://chromium-review.googlesource.com for this purpose.
+
+## Sending patches
+
+The basic git workflow for modifying libwebp code and sending for review is:
+
+1. Get the latest version of the repository locally:
+
+ ```sh
+ git clone https://chromium.googlesource.com/webm/libwebp && cd libwebp
+ ```
+
+2. Copy the commit-msg script into ./git/hooks (this will add an ID to all of
+ your commits):
+
+ ```sh
+ curl -Lo .git/hooks/commit-msg https://chromium-review.googlesource.com/tools/hooks/commit-msg && chmod u+x .git/hooks/commit-msg
+ ```
+
+3. Modify the local copy of libwebp. Make sure the code
+ [builds successfully](https://chromium.googlesource.com/webm/libwebp/+/HEAD/doc/building.md#cmake).
+
+4. Choose a short and representative commit message:
+
+ ```sh
+ git commit -a -m "Set commit message here"
+ ```
+
+5. Send the patch for review:
+
+ ```sh
+ git push https://chromium-review.googlesource.com/webm/libwebp HEAD:refs/for/main
+ ```
+
+ Go to https://chromium-review.googlesource.com to view your patch and
+ request a review from the maintainers.
+
+See the
[WebM Project page](https://www.webmproject.org/code/contribute/submitting-patches/)
for additional details.