< InfrastructureRevision as of 23:47, 11 February 2020 by Ngraham (talk | contribs) (Add a rudimentary section on collaborating using multiple remotes)(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff) GitLab is KDE's patch review system. This page is intended to serve as a general-purpose introduction to the most important aspects: submitting and reviewing patches. It should not take long before you are happily using Phabricator. Information The KDE community does not yet use GitLab for bug reporting. This is planned, but not yet completed. In the meantime, please submit bug reports only using https://bugs.kde.org. Contents 1 Workflow 2 Logging in 3 Submitting a merge request 3.1 Build the project from source and make your change 3.2 Fork the project 3.3 Add the fork to your source checkout 3.4 Make a branch and push to your fork 3.5 Create the Merge Request 3.6 What happens next? 4 Testing someone else's Merge Request 4.1 Check out the Merge Request and compile the software 4.2 Perform QA 4.3 Perform code review 4.4 Engage with the author and other reviewers 5 Pushing commits to somebody else's fork Workflow The sanest and easiest way to submit code to KDE is by following a typical feature branch workflow: keep your master branch synchronized with the origin repository, and make all changes on separate branches. Each Merge Request needs its own private, temporary branch. Once your Merge Request has been merged, delete the feature branch, and make another new branch for the next Merge Request. In this way, you can be working on multiple changes at once without them colliding with one another because each one lives on its own branch. Logging in Navigate to https://invent.kde.org/users/sign_in and log in using the username and password for your KDE Identity account. If you don't have one, you can sign up for one here. Submitting a merge request Contributing to KDE code using GitLab involves submitting a Merge Request. A Merge Request is a request to merge some of your code into the project's permanent source code repo. Here's how: Build the project from source and make your change First you need to check out the project, compile it from source, and make some changes that you would like to submit to KDE! Instructions for doing this can be found at Get Involved/development. You will wind up with a checkout of the project at ~/kde/src/[the project name] with some local changes applied to it. Information If you prefer a different organizational structure for source code on your machine, you can of course check out the local copy of your KDE repos wherever you want. However for the purposes of this documentation, we will assume that they are located inside ~/kde/src/ Fork the project Once you have made some local changes that you would like to submit to KDE, you need to create a personal fork of the project and push your changes to the forked copy. Navigate to https://invent.kde.org/kde and locate the project. If it is not visible in the list, you can use the search field. Once you find the project, click on it: On the project's page, click on the "Fork" button in the top-right corner of the screen: This will take you to a page asking you what namespace you want to create the project under. Click on yourself: After a moment, the system will finish creating the fork and take you to the page for your fork. On that page, click on the blue "Clone" button in the top-right corner: In the pop-up that appears, click on the "copy" button to the right of the upper text field. This will copy the URL for the fork onto your clipboard. Add the fork to your source checkout Next, open your terminal app and navigate to the location where the project's repo lives (i.e. ~/kde/src/[the project name]). You need to add your fork as a remote to the existing repo: git remote add fork [the URL you copied to your clipboard] Run git remote -v. You should see something like this: $ git remote -v fork [email protected]:ngraham/kid3.git (fetch) fork [email protected]:ngraham/kid3.git (push) origin https://invent.kde.org/kde/kid3.git (fetch) origin https://invent.kde.org/kde/kid3.git (push) This means you have two remotes set up for your repo: "origin" points to the original repo, and "fork" points to your fork of it. Make a branch and push to your fork Now that you have your fork set up, it's time to create a branch to track your work and make a commit. git checkout -b my_awesome_feature git add [the files you changed] git commit At this point you have a branch in your local repo called "my_awesome_feature" (Hopefully in reality it is named something a bit more appropriate!) that has a commit on it with your work. Now push it to your fork: git push fork my_awesome_feature This will produce a message somewhat like this: $ git push fork my_awesome_feature Enumerating objects: 5, done. Counting objects: 100% (5/5), done. Delta compression using up to 4 threads Compressing objects: 100% (3/3), done. Writing objects: 100% (3/3), 303 bytes | 303.00 KiB/s, done. Total 3 (delta 2), reused 0 (delta 0) remote: This commit is available for viewing at: remote: https://invent.kde.org/ngraham/kid3/commit/23a702439f494806cf3cfe14f212df58a0075bba remote: remote: To create a merge request for my_awesome_feature, visit: remote: https://invent.kde.org/ngraham/kid3/merge_requests/new?merge_request%5Bsource_branch%5D=my_awesome_feature remote: To invent.kde.org:ngraham/kid3.git * [new branch] my_awesome_feature -> my_awesome_feature Create the Merge Request Notice the "To create a merge request for my_awesome_feature..." message above. You can copy-and-paste the URL shown below it into a web browser. On some terminal apps, such as Konsole and Yakuake, you can ctrl+click on the link to go right there! You will be taken to a web page that looks like this: In the Description section, write at least one sentence describing your change and why it is necessary, adding more details if needed. For Merge Requests that change something about the appearance or user interface, it's customary to include a screenshot of how the interface looks after your change has been applied. Bonus points for including a "Before" image too, so reviewers can easily compare them. In the section below, it is very important that you make sure all three checkboxes are checked: Once you're done with that, click the "Submit Merge Request" button! What happens next? After you've submitted your Merge Request, KDE developers who work with the software in question will review it and provide feedback. This can often take a few days. However, if nobody has responded after a week, it's likely that the review was overlooked (sorry about that!) and it's appropriate to make a comment saying, "Ping!" or something to that effect. Once the Merge Request is accepted, KDE Developers will merge it for you! Testing someone else's Merge Request First you'll need a development environment set up. If you haven't done that yet, it's time to do so. Follow the instructions on Get_Involved/development#Set_up_your_development_environment. It is also advisable to set up the git mr tool, which makes testing Merge Requests a breeze. Here's how to install it: Debian/Ubuntu/KDE Neon sudo apt install git-extras Arch / Manjaro trizen -S git-mr TODO: openSUSE and Fedora See https://tsdgeos.blogspot.com/2020/01/git-mr-easily-downloading-gitlab-merge.html for more information. Check out the Merge Request and compile the software First check out or enter the source repository for the software that's being patched. For example, let's say you want to test a Merge Request for Okular. If you've never built it before, check it out and build it once first: kdesrc-build okular Now go to its source directory: cd ~/kde/src/okular Find the Merge Request's ID. For example, for https://invent.kde.org/kde/okular/merge_requests/80, the ID is 80. ...and apply the Merge Request: git mr 80 Now it's time to compile and run the software to make sure that the Merge Request does what it says it does and doesn't cause any regressions! Compile the patched source code: kdesrc-build okular --no-src --resume-from okular Those arguments will tell kdesrc-build to not update the source code and to not build any dependencies. If it didn't compile, that's reason alone to reject the Merge Request! Go to the web page for the Merge Request and report your findings. Perform QA If it did compile, then it's time to perform QA, because it's important to thoroughly test Merge Requests to ensure that bad code and regressions don't slip in. This is the entire purpose of having a review infrastructure; it is very important. First make sure the unit tests all pass: cd ~kde/build/kde/applications/okular ctest If any tests fail, report this through a comment on the Merge Request's web page. Does everything all still work for you? If not, return to the web page and request changes, writing a detailed comment explaining what didn't work. It is permissible to do this even if you have not been specified as a reviewer! Anyone can reject a Merge Request on the grounds that it does not work, does not do what it says it does, or causes regressions. Next, try to break the Merge Request. Here are some ideas: Remove the program's configuration file (~/.config/<program name>rc ) and re-open it Try the program with a HiDPI scale factor (or without one) or with a different default font size If it's a new feature, feed it unexpected input Test related functionality A good Merge Request will handle corner cases and variations in configuration. The price of configurability is vigilant testing! We owe it to our users to test using many configurations, not just the defaults or our personal settings. Perform code review Note Need a section on code review here, preferably written by a core KDE developer or another very experienced developer Engage with the author and other reviewers After you have run the program and evaluated the Merge Request, it's time to leave some review comments on the webpage. If you have been specified as a reviewer, or are a member of a group that has been specified as a reviewer, it is permissible to Accept the Merge Request. But keep in mind that reviewing involves responsibility: you are giving a thumbs-up to code that will be run potentially by millions of people. If you accept and land a Merge Request that causes regressions, you will be expected to help fix it if the original author cannot or has disappeared. It's important to take the reviewer role seriously. Pushing commits to somebody else's fork Sometimes someone will say "hey let's work on my branch together." So you will be pushing commits not to origin, and not to your fork, but to someone else's fork. Let's say you want to work on joliveira's "gsoc2019_numberFormat" branch. First you would need to add the URL for his fork as a remote: $ cd ~/kde/src/okular $ git remote add joliveira_fork [email protected]:joliveira/okular.git $ git remote -v aacid_fork [email protected]:aacid/okular.git (fetch) aacid_fork [email protected]:aacid/okular.git (push) joliveira_fork [email protected]:joliveira/okular.git (fetch) joliveira_fork [email protected]:joliveira/okular.git (push) origin https://invent.kde.org/kde/okular.git (fetch) origin https://invent.kde.org/kde/okular.git (push) Notice how there are now multiple forks set up as remotes. Next, you need to fetch all the repo metadata from the new remote: git fetch joliveira_fork This will download the list of branches. The next step is to switch to the one you want to collaborate on: git checkout --track joliveira_fork/gsoc2019_numberFormat This will create a local branch named "gsoc2019_numberFormat" from the contents of the remote branch joliveira_fork/gsoc2019_numberFormat and that also "tracks" it. This means that if someone else pushes changes to a remote version of that branch, you can run git pull --rebase while on your local "gsoc2019_numberFormat" branch to bring it up to date. Next, make your changes, add and commit. Then push the changes to the remote joliveira_fork remote: git push joliveira_fork gsoc2019_numberFormat For more information, see https://tsdgeos.blogspot.com/2020/02/working-with-different-remotes-in-git.html Retrieved from "https://community.kde.org/index.php?title=Infrastructure/GitLab&oldid=87533" Content is available under Creative Commons License SA 4.0 unless otherwise noted.