Getting Started

There are many ways to get involved and contribute to the WebKit Project. To start contributing code, you can follow the setup steps outlined here.

Overview

Here is a brief list of what you’ll need to do in order run a custom development build of WebKit:

  • Install the proper developer tools
  • Download the WebKit source code.
  • Build from source.
  • Run your custom build of WebKit.

Installing Developer Tools

You’ll need the right tools to build WebKit from source code. Each platform has different instructions.

Getting the Code

To download a pre-built bundle containing the latest WebKit, get a WebKit Nightly Build. You can also download a snapshot of the WebKit source code in a tarball archive.

Building WebKit

With the right tools installed and a copy of the source, you’re ready to build WebKit. Grab a cup of your preferred beverage and follow the steps in the Building WebKit guide.

Running WebKit

When you are able to build WebKit successfully, you can use the run scripts included in the WebKit source files to run your personal build of WebKit. See the Running WebKit reference page.

Contribute

Congratulations! You’re 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.

Staying in Touch

Mailing Lists

Before posting to any mailing list, make sure that you have checked our page on how to ask questions about WebKit. There are a number of mailing lists for WebKit related topics. Archives for all the lists as well as information on joining them are available on the individual list page.

  • For requests for help related to using WebKit, direct it to webkit-help. Most questions will go to this mailing list. Usual topics include how to build WebKit, how to use WebKit’s APIs, how to embed WebKit, and how to port WebKit.
    • For WebKitEFL specific discussions use webkit-efl.
    • For WebKitGTK+ specific discussions use webkit-gtk.
  • If you are looking for or have a WebKit-related job, post it to webkit-jobs.
  • Discussion of the WebKit project’s development happens on webkit-dev. If you do not intend to contribute patches to WebKit, you should direct your questions to webkit-help.
  • Notification of review requests are sent to webkit-reviews. Bugzilla automatically notifies this list of all patches awaiting review. Subscribe to it if you are a WebKit reviewer or just want to follow along.
  • New repository commit information is automatically sent to webkit-changes. Subscribe and stay abreast of the latest changes.
  • New bugs are assigned to the webkit-unassigned by default, which is notified of the new bugs, as well as their updates and changes.
  • If you would like to discuss development of applications using WebKit on OS X or iOS, the right place is the Apple Developer Forums.

IRC

You can find WebKit developers, testers, and other interested parties in channel #webkit on the FreeNode IRC network (irc.freenode.net).

Bug Tracker

You can report new bugs and monitor the state of existing bugs in our Bugzilla, in the WebKit product.

Other Useful Info

Trac Want to know more about what we’re up to? Check out WebKit Trac where you can browse the source and see our changes.

Build Bot Another way to see the current state of things is our build bot. This build system helps us identify build and test case failures fast, and as such is invaluable to us.