This document describes contribution example how to contribute the code:
For this example, we will consider a hypothetical bug which affects the Sailfish Browser. The community member “Alice” discovers that for some content-aggregator sites, the wrong User Agent string seems to be used when fetching content. She decides to investigate and contribute a fix. These are the steps she takes:
1) She files an issue on https://github.com/sailfishos/sailfish-browser/issues with example issue template from above.
2) She comments on the issue to say that she will investigate the issue.
3) She searches for the upstream code repository, and finds https://github.com/sailfishos/sailfish-browser and notes that it depends on embedlite-components-qt5. After browsing that source code, she realises that the user agent override behaviour is defined in code from the embedlite-components-qt5 package.
4) She searches for that package on her Sailfish OS device via command
rpm -qi embedlite-components-qt5 | grep URL and finds its upstream repository URL https://github.com/sailfishos/embedlite-components
5) She creates a personal fork of that repository using the web interface at https://github.com/sailfishos/embedlite-components
6) She clones that personal fork to her local host machine via
git clone https://github.com/alice/embedlite-components.git> alice-embedlite-components
7) She attempts to build the package but it fails to locate some build time dependencies
# cd into her local clone ~ $ cd alice-embedlite-components # attempt to build the package for her SailfishOS-220.127.116.11-armv7hl target ~/alice-embedlite-components $ sfdk config target=SailfishOS-18.104.22.168-armv7hl ~/alice-embedlite-components $ sfdk build No provider of 'xulrunner-qt5-devel >= 60.9.1' found. Building target platforms: armv7hl-meego-linux Building for target armv7hl-meego-linux error: Failed build dependencies: xulrunner-qt5-devel >= 60.9.1 is needed by embedlite-components-qt5-1.0.0-1.armv7hl pkgconfig(nspr) is needed by embedlite-components-qt5-1.0.0-1.armv7hl
8) She knows that she needs to enable additional package repositories under her build environment. To find out which ssu repository provides those packages, she now ssh’s into her device, and runs
zypper info (can also use
pkcon get-details or search on OBS).
~/alice-embedlite-components $ ssh defaultuser@device [defaultuser@XperiaXA2-DualSIM ~]$ devel-su -p pkcon install zypper ## snipped ## [defaultuser@XperiaXA2-DualSIM ~]$ zypper info xulrunner-qt5-devel Loading repository data... Reading installed packages... Information for package xulrunner-qt5-devel: -------------------------------------------- Repository : jolla Name : xulrunner-qt5-devel Version : 60.9.1+git61-1.11.6.jolla Arch : armv7hl Vendor : meego Installed : No Status : not installed Installed Size : 6.4 MiB Summary : Headers for xulrunner Description : abzaza Development files for xulrunner.
9) She now knows that it comes from the “jolla” repository. She goes back to her development terminal, and enables the repository under her build environment the way suggested in Enabling Additional Package Repositories:
~/alice-embedlite-components $ sfdk tools exec SailfishOS-22.214.171.124-armv7hl # might be required to register her SDK depending on her SDK setup. [SailfishOS-126.96.36.199-armv7hl] ~ # ssu r # list the available repos [SailfishOS-188.8.131.52-armv7hl] ~ # ssu lr ## snipped ## Disabled repositories (global, might be overridden by user config): - jolla ... https://releases.jolla.com/releases/184.108.40.206/jolla/armv7hl/ ## snipped ## # she enables the repository. [SailfishOS-220.127.116.11-armv7hl] ~ # ssu er jolla # she refreshes the available package list [SailfishOS-18.104.22.168-armv7hl] ~ # zypper ref -f # now she is ready to go back sfdk to build the package again [SailfishOS-22.214.171.124-armv7hl] ~ # exit ~/alice-embedlite-components $ sfdk build # success! The missing package was found now
10) Now that she has successfully built the package locally, she tests deploying the package.
# she registered her device using the "my device" name within the Sailfish IDE before ~/alice-embedlite-components $ sfdk config device="my device" # she can deploy the convenient zypper-dup way ~/alice-embedlite-components $ sfdk deploy --zypper-dup # or the forceful way ~/alice-embedlite-components $ sfdk deploy --manual ~/alice-embedlite-components $ sfdk device exec [defaultuser@XperiaXA2-DualSIM ~]$ devel-su rpm -Uvh --force RPMS/embedlite-components-qt5-1.0.0-1.armv7hl.rpm
11) After rebooting the device and opening browser, she sees that it works. She is now ready to begin development. She makes changes, adds debug statements, deploys the package to the device, and retrieves the logging information from the journal with
devel-su journalctl -af | grep browser.
12) After she has resolved the issue, and commits her fix locally. She then pushes the commit to her personal fork, and creates a pull request to the upstream repository. This will look something like https://github.com/sailfishos/embedlite-components/pull/14
13) She now updates the issue report with her findings, and a link to her pull request.
14) After receiving some review comments, she updates her commit with
git commit --amend, force pushes it to her personal fork via
git push origin master:master --force and comments in the merge request that it has been updated.
15) The maintainer merges the patch, tags it, and comments on the original bug report the tagged version which should be in a future release.