WebKit Overview¶

WebKit is a cross-platform web browser engine. On iOS and macOS, it powers Safari, Mail, Apple Books, and many other applications.

Getting Up and Running¶

Downloading the Source Code¶

git clone https://github.com/WebKit/WebKit.git WebKit

Building WebKit¶

Compilation instructions are for macOS. For other platforms additional instructions may be found here.

cd WebKit
Tools/Scripts/build-webkit

Running Minibrowser¶

Tools/Scripts/run-minibrowser

(Optional) Add Scripts Directory to your PATH¶

export PATH=$PATH:`pwd`/Tools/Scripts

Contribute¶

Congratulations! Youre up and running. Now you can begin coding in WebKit and contribute your fixes and new features to the project. For details on submitting your code to the project, read Contributing Code.

Trying the Latest¶

On macOS, download Safari Technology Preview to test the latest version of WebKit. On Linux, download Epiphany Technology Preview. On Windows, you will have to build it yourself.

Reporting Bugs¶

Search WebKit Bugzilla to see if there is an existing report for the bug you've encountered.
Create a Bugzilla account to to report bugs (and to comment on them) if you haven't done so already.
File a bug in accordance with our guidelines.

Once your bug is filed, you will receive email when it is updated at each stage in the bug life cycle. After the bug is considered fixed, you may be asked to download the latest nightly and confirm that the fix works for you.

Staying in Touch¶

Before getting in touch with WebKit developers using any of the avenues below, make sure that you have checked our page on how to ask questions about WebKit.

You can find WebKit developers, testers, and other interested parties on the #WebKit Slack workspace. Join the WebKit slack, and stay in touch.