Qt for Python/Development Getting Started

From Qt Wiki
< Qt for Python
Revision as of 15:21, 27 May 2018 by AutoSpider (talk | contribs) (Move Category:QtForPython -> Category:Qt for Python)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Overview

The Qt for Python (PySide2) project is supported by The Qt Company and the developers who use Qt for Python. This means that anyone who shares an interest in the project can join the community, participate in its decision making processes, and contribute to its development. This page will summarize the key points around how you can contribute to the project. Qt for Python follows the same development process as the Qt project, it's in your best interest to read the Qt Project Wiki.

Reporting Bugs

Bugs should be reported to the Qt bug tracker at https://bugreports.qt.io/browse/PYSIDE Please include details on how to reproduce your problem and consider contributing a fix for it.

Contributing Patches

Because PySide2 is a Qt project, all patches must be submitted through Qt's Gerrit code integration system. Make sure you go through Gerrit's introduction page before starting contributing. All developers need a user account on Gerrit and to agree to the Qt Contributor Agreement. Patches submitted via the bug tracked, mailing list, or pull requests cannot be accepted.

A bug tracker (JIRA) account is needed before a Gerrit account can be created:

  • JIRA account
  • Gerrit account
    • Go to codereview.qt-project.org and click on Sign In
    • Login with the username/password you created with JIRA
      • NOTE: Gerrit usernames are case-sensitive, but JIRA usernames are not. If you attempt to log into Gerrit with different capitalizations, you will end up with multiple accounts.
    • Enter your full name and click Save Changes
    • Skip the SSH part for now and scroll all the way down and click "New Contributor Agreement"
      • Select Individual or Corporate, then scroll down and type I AGREE then submit
      • To check if your agreement was submitted, click on Settings then Agreements

Configuring local directories for Gerrit

After cloning the project's repository:

git clone --recursive https://codereview.qt-project.org/pyside/pyside-setup pyside

be sure you are on the desired branch you want to contribute. Most of the work is being done under *5.9*, but you can submit patches to 5.11 and dev branches.

Please follow the Qt Setting up Gerrit instructions, particularly the Local Setup and Configuring Git sections. Add a gerrit remote to local project directory with:

git remote add gerrit ssh://codereview.qt-project.org/pyside/pyside-setup  

Pushing changes to Gerrit

After you have committed your changes locally, you can push them to Gerrit like this:

git push gerrit HEAD:refs/for/<branch>

where <branch> is the branch you were working at the moment of doing changes in the code.