Qt for Python/Development Getting Started

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.

Branch status

• 5.12: Cherry-pick mode
• 5.13: Bug-fixing only
• 5.14: Bug-fixing only
• 5.15: Open Development
• dev: refer to 5.15

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, contributors need a Qt Account and need to agree to the Qt Contributor Agreement (see Qt Contribution Guidelines ). All patches must be submitted through Qt's Gerrit code review and integration system. Make sure you go through Gerrit's introduction page before starting contributing. Patches submitted via the bug tracker, mailing list, or pull requests cannot be accepted (unless they are trivial, less than 10 lines). We also recommend to have a look at the CommitPolicy, the Coding Style and the Coding Conventions.

The Qt Account can be used for the bug tracker JIRA and Gerrit with some configuration:

• Verify the JIRA account
  • Go to bugreports.qt.io and try to log in, potentially fill out more details
• Configure the Gerrit account
  • Go to codereview.qt-project.org and click on Sign In
  • Login with the username/password of the Qt Account
    • 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.15, but you can submit patches to 5.14 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.

Don't forget to Add Reviewers You can click on the left menu of your patch the option "Add Reviewers" and add the word "pyside2", that will include the developers of the project so they can look at it. If you want to add someone directly, ask in the many chat platform the project has who to add for a specific path.

Files location

This cases assumed you already entered the pyside-setup git directory:

• If you are fixing a bug, it's probable that you already now the location for the typesystem

(sources/pyside2/PySide2/<QtModule>/typesystem_<name>.xml), and glue code (sources/pyside2/PySide2/glue), so your contribution should probably be there.

• Issues related to the build process would be probably located inside the scripts directory called build_scripts/
• If you want to add a new example, please place them in the examples/ directory.
• To update the documentation (not the API pages), adding written tutorials, changing typos, or details from the general, you should look into sources/pyside2/doc for PySide, and sources/shiboken2/doc for the Shiboken one. We use Sphinx for the docs, so please read https://doc.qt.io/qtforpython/gettingstarted.html#building-the-documentation carefully.
• Modifying the API pages from the documentation is a bit more tricky:
  • We use qdoc to generate WebXML files that we later modify and use.
  • The code snippets you see time to time in C++ comes from Qt. What we need to do is to copy those files from Qt/C++ and edit them locally. You can check many of them in sources/pyside2/doc/codesnippets. If the specific class you want to modify is there, it's just a matter of modifying the file and submit a patch, otherwise, you would need to look for the specific snippet file in Qt/C++'s repositories and copy it over, then translate it.

Check the Qt Release wiki pages, e.g.: https://wiki.qt.io/Qt_5.15_Release to see if a certain branch is still in development for features, otherwise you can ask in the different chat services the team has.