View source for Qt Contribution Guidelines

[[Category:Developing_Qt::Guidelines]]

__TOC__

We have a community around the development of the Qt libraries, Qt related tools and add-ons. These guidelines will introduce you to the tools and mechanics as well as to the philosophies behind the development of Qt. You will learn how to set up your development environment for working on the library itself and how to submit code/documentation for inclusion.

[[File:Qt_Contribution_Process.png]]

== Creating Changes for Inclusion Into Qt ==

When you intend to make changes, you need git clones [[Setting up Gerrit|configured for use with Gerrit]]. This mostly supersedes the more user-oriented instructions for [[Get The Source|getting the Qt source code]] and setting up your local working environment to build Qt.

The [[Gerrit Introduction|Gerrit tutorial]] describes in detail how our version of Gerrit works for the Qt Project. Here is the short version.

There are some steps you need to follow only once:
# [http://bugreports.qt.io Create an account] on the Qt Project bug tracker (Jira). This will be the same login information you will use in the [http://codereview.qt-project.org Gerrit code review system]. Even though the account credentials are shared, you still need to complete the account details on the [http://codereview.qt-project.org Gerrit code review system]. See the next step.
# Login on and set up [http://codereview.qt-project.org/#settings,contact your Gerrit account] by adding your full name, email address, and public SSH key.
# Review and agree to the Qt Project's contribution agreement in Gerrit. You only need to do this once, unless the license changes. If your company has a corporate contribution agreement, ask the owner of the according Gerrit user group to add your account to this group.
# Clone Qt from [http://code.qt.io the read-only mirror].
#* Qt 4: Add a git remote called "gerrit" in your cloned repository, which points to the Qt 4 project on <tt>codereview.qt-project.org</tt>.
#* Qt 5: When you run the <tt>init-repository</tt> script, provide your Gerrit username to the --codereview-user option.

Then there are steps you need to follow for each patch you contribute:
# Push you changes to remote "gerrit" to the branch <tt>refs/for/master</tt>, if <tt>master</tt> is the branch you are targeting.
# The [[Early Warning System]] (EWS) will quickly kick in and check your patch. Please act upon the reports and push updates to the patch.
# '''Add relevant reviewers to your change(s).''' If you don't do this, your change may go unnoticed. To find possible reviewers, you can:
#* examine the Git history with 'git log' and/or 'git blame',
#* see the [[Maintainers|Maintainer chart]],
#* ask on IRC, or
#* ask on relevant mailing lists like development@qt-project.org or qt-creator@qt-project.org, etc.
# Wait for reviews, and actively partake in the review of your change(s).
#* If your contribution is deemed to not align with the project's vision or goals, you should abandon the change at this point.
#* If your contribution is deemed unready, you need to fix it up according to the reviews.
# Submit your patch. If your contribution satisfies the technical requirements, then you or the Approver are able to submit the patch into the staging branch, or directly into the target branch, if there's no CI system on that particular branch and/or repository.
#* To determine if the branch is covered by the CI system, you may check [http://testresults.qt.io/ci/ the CI logs] ; if the project/branch can be found at this link, it is covered by CI.
#* If the [[Public Autotest Infrastructure|continuous integration (CI)]] system rejects your patch, you need to fix the issues so it passes the project's build and autotest systems.
# When CI is successful, your changes are automatically included and added to the official Qt repository.

See [[Gerrit Caveats and Hints]] to avoid common traps.

== Style, Conventions and Principles ==

For development of the Qt framework we follow the framework's [[Qt Coding Style]] and we stick to our established [[Coding Conventions]]. The [http://techbase.kde.org/Policies/Library_Code_Policy KDE Library Code Policy] is based on Qt's, so much is shared with Qt's. You can find more information there that isn't in Qt pages.

Qt Creator uses its own [https://doc-snapshots.qt.io/qtcreator-extending/coding-style.html Qt Creator Specific Coding Style & Conventions]. It is similar to the Qt framework's coding style and conventions, but there are some differences and additions.

In addition, conventions for writing good user interface messages texts that play well with Qt Linguist can be found under [[UI Text Conventions]].

Our [[API Design Principles]] aim for perfection.

Note that Qt is an open source library, and must therfore be compilable in its completeness using freely available tools and libraries. This means that you should not contribute code that uses any kind of private APIs.

Please follow the [[Commit Policy]].

Verify that your commits have correct author information, including your name and email address as it is registered in Gerrit.

== Localization to Other Languages ==

The process of contributing translations is described in [[Qt Localization]].

== Developer's Lounge ==

If you have any questions about the development of Qt, feel free to join the <tt>#qt-labs</tt> IRC channel on <tt>irc.freenode.net</tt> and the [http://lists.qt-project.org/mailman/listinfo/development Qt development mailing list] Qt Creator development, join <tt>#qt-creator on irc.freenode.net</tt> and the [http://lists.qt-project.org/mailman/listinfo/qt-creator Qt Creator mailing list].

For a full list of IRC channels of interest to Qt developers, [[Online Communities]].