[[PageOutline]] = Contributing to the Qt Port of WebKit = [http://gitorious.org/qtwebkit Gitorious.org] is hosting a [http://gitorious.org/qtwebkit public git repository] of the QtWebKit port. == Coding Style == Effective immediately all commits to QtWebKit should use the [http://webkit.org/coding/coding-style.html WebKit coding style] for '''all files''' in the project. That includes qwebview(.h|cpp), qwebpage(.h|.cpp) and all others. Repeat: the Qt style should not be used. Thank you. == Reporting Bugs == Bug reports, feature requests, and patches for the Qt-port of WebKit should all be submitted to the WebKit Bugzilla. Please follow the standard [http://webkit.org/quality/reporting.html reporting guidelines] and [http://webkit.org/quality/bugwriting.html steps for writing good bug reports], with the following specifics for the Qt port: * '''All bugs related to the Qt port of WebKit should have the keyword 'Qt'''' * Use the component to specify which area of the code you're targeting * There are components for rendering, plugins, tests, text, forms, etc. * The 'WebKit Qt' component should only be used for bugs/features in the QtWebKit API * Add the keyword 'Performance' if the bug is performance-related * Use the severity 'Enhancement' for feature-requests/enhancements * Use the severity 'Blocker' for compilation errors/build breaks * Use the severity 'Critical' for crashes * Use the severities 'Minor, Normal, Major' for bugs You can use [http://webkit.org/new-qtwebkit-bug http://webkit.org/new-qtwebkit-bug] as a handy template. === Useful filters for existing Qt bugs === [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&keywords_type=allwords&keywords=Qt&order=Importance Bugs (unconfirmed or new)] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&component=Accessibility&component=CSS&component=Evangelism&component=Forms&component=Frames&component=History&component=HTML+DOM&component=HTML+Editing&component=Images&component=Java&component=JavaScriptCore&component=JavaScriptGlue&component=Layout+and+Rendering&component=Page+Loading&component=PDF&component=Platform&component=Plug-ins&component=Printing&component=SVG&component=Tables&component=Text&component=Tools+%2F+Tests&component=Web+Inspector&component=Web+Template+Framework&component=WebCore+JavaScript&component=WebCore+Misc.&component=WebKit+API&component=WebKit+Gtk&component=WebKit+Misc.&component=WebKit+Qt&component=WebKit+Website&component=WebKit+wx&component=XML&component=XML+DOM&long_desc_type=allwordssubstr&long_desc=&bug_status=ASSIGNED&bug_status=REOPENED&keywords_type=allwords&keywords=Qt&order=Importance Bugs (assigned)] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&component=WebKit+Qt&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&keywords_type=allwords&keywords=Qt&order=Importance API] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=Blocker&keywords_type=allwords&keywords=Qt&order=Importance Compilation] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=Critical&keywords_type=allwords&keywords=Qt&order=Importance Crashes] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=Enhancement&keywords_type=allwords&keywords=Qt&order=Importance Enhancements] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&component=Layout+and+Rendering&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&keywords_type=allwords&keywords=Qt&order=Importance Rendering and Layout] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&keywords_type=allwords&keywords=Qt+Performance&order=Importance Performance] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&component=Plug-ins&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&keywords_type=allwords&keywords=Qt&order=Importance Plugins] [https://bugs.webkit.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&product=WebKit&component=Tools+%2F+Tests&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&keywords_type=allwords&keywords=Qt&order=Importance Tools and Tests] [https://bugs.webkit.org/showdependencytree.cgi?id=29799 Qt 4.6 Release Backlog] [https://bugs.webkit.org/showdependencytree.cgi?id=31552 QtWebKit 4.7 Pending API] == Checking out the sources == Developers who wish to contribute to the port can check out the sources like so: {{{ git clone git://gitorious.org/webkit/webkit.git }}} This is a git mirror of the WebKit SVN repository. If you also want to track the staging branches for QtWebKit releases, do: {{{ git remote add qtwebkit git://gitorious.org/+qtwebkit-developers/webkit/qtwebkit.git }}} This repository has the QtWebKit staging branches and other branches specific to the QtWebKit port. == Hacking on QtWebKit == * [wiki:"QtWebKitHacking" QtWebKit overview] === Running the tests === To run the tests the normal WebKit layout test infrastructure is used. In addition you need a fixed set of fonts for testing. You can download them using Git from Gitorious: {{{ git clone git://gitorious.org/qtwebkit/testfonts.git }}} Then you have to set the WEBKIT_TESTFONTS variable to point to the newly checked-out testfonts directory. As the last step you can just run {{{ run-webkit-tests }}} from the WebKitTools/Scripts directory. Individual tests can be run just directly using for example {{{ run-webkit-tests LayoutTests/fast/forms/plaintext-mode-1.html }}} For debugging at test it may also be useful to run it directly in DumpRenderTree (with gdb): {{{ WebKitBuild/Debug/bin/DumpRenderTree -v LayoutTests/fast/forms/plaintext-mode-1.html }}} The expected output can usually be found in the file with the same name as the test itself but with the .expected extension. === Building API Docs === Before you can build the API docs you need make sure to have Qt build from sources and run {{{make docs}}} in your Qt build directory once. This will ensure that the Qt API documentation is built and can be referenced from the QtWebKit docs and it will also ensure that qdoc (the tool that generates the API docs) is built. To build the QtWebKit API docs simply run {{{make docs}}} in your build directory, i.e. {{{WebKitBuild/Release}}}. The output will be generated in HTML in the {{{doc/html}}} subdirectory. == Information on Git for QtWebKit developers == * [wiki:"QtWebKitGitInstructions" QtWebKit Git Instructions] * [wiki:"UsingGitWithWebKit" Using Git with WebKit] * [http://ktown.kde.org/~zrusin/git/git-cheat-sheet-medium.png A Git cheat sheet] * [http://eagain.net/articles/git-for-computer-scientists/ An excellent article on Git for computer scientists] == The Plan == * [wiki:"QtWebKitTodo" TODO List] * [wiki:"QtWebKitJournal" Stabilization Journal] == Communication == We use the regular webkit-dev mailing list to coordinate. You can also find us in the #webkit channel on irc.freenode.net. We have two mailing lists specific to the QtWebKit port * [https://mx.staikos.net/mailman/listinfo/qtwebkit-bugs Bug Mailing List] * [https://mx.staikos.net/mailman/listinfo/qtwebkit-commits Commits Mailing List] == Obtaining Check-In Privileges == Contributors with a proven track record of good patch submissions and that have demonstrated an ability to work well with the community can obtain check-in privileges to the QtWebKit git repository. The various branches of the git repository mirror the branches in the [http://webkit.org/building/checkout.html upstream public webkit svn repository]. Patches that land on a branch in the git repository are not automatically pushed to the svn repository. Patches intended for the svn repository must first be reviewed and then committed by developers with [http://webkit.org/coding/contributing.html sufficient privileges]. Patches that are not specific to the QtWebKit port of the webkit project should not be submitted to the git repository rather they should be contributed directly to the upstream public webkit svn repository. To obtain check in privileges to the git repository the contributor should inquire from one of the Administrator(s) of the [http://gitorious.org/+qtwebkit-developers qtwebkit-developers team.]