Infrastructure/Github Mirror

From KDE Community Wiki
Revision as of 20:30, 25 August 2019 by Sredman (talk | contribs) (→‎How do I submit “Pull Requests”?: Update documentation for GitLab)

GitHubMirror

KDE is managing a read-only mirror of our repos on Github. It's located at https://github.com/KDE .

We want to make KDE sources easy to find, share and build upon; and most importantly we want your contributions to count towards your github profile. :)

FAQ

Why don't you enable pull requests?

Our central repositories are handled by our awesome sysadmins over on kde.org where we have full control and tighter integration within our services. If we start using multiple repositories and making developers look in two places that gets very complicated and unfair on the maintainers.

Also as an open source project, it's very important for us to keep to using open source tools. Github does not meet that requirement.

How do I submit “Pull Requests”?

KDE is in the process of moving many projects from Phabricator, our old code-management tool, to GitLab. Currently some projects are still hosted on Phabricator while others are hosted on Gitlab.

To determine which tool should be used for a particular project:

  1. Look at the project's documentation (README.md, wiki page, etc.). It should tell you how the project wants to accept patches.
    • Unfortunately, some projects documentation still needs updating.
  2. Look at the listings of projects on KDE GitLab. If the project is there, that is most likely where patches should be uploaded.
    • Check and see if there are already merge requests on GitLab. If there are some, it is a pretty certain sign that the project is using GitLab.
  3. Ask the project developers. We are always happy to talk with potential contributors and point you in the right direction!

Follow the instructions below depending on which patch-uploading tool the project uses:

For Projects using GitLab

The process of using GitLab is very similar to using GitHub.

  • Log in to KDE's GitLab
  • Fork the repository of the project you want to work on
  • Make a branch in your fork
  • Make changes, commit them to your branch, and push
  • When you push you should be given a link to easily make a merge request. If not, navigate to your fork on GitLab and make a pull request from there

For Projects using Phabricator


The maintainer for this software will then comment and merge your request.

Alternatively you can use the command arc diff to streamline the process. More details are available in the Phabricator page.

How do I submit “Issues”?

Please file a bug report or wish at https://bugs.kde.org/

Where can I find the “original sources”?

All KDE GIT repositories are available for browsing at https://cgit.kde.org/ with each repository including possible git clone URLs at the bottom of their respective summary pages. The general command format for cloning a repository being:

git clone (https|git)://anongit.kde.org/<repository>.git

Additionally to the top-level repositories mostly mirrored on GitHub so-called scratch and clone repositories exist for allowing KDE developers to publish repositories without jumping through organizational hurdles.

For details on KDE's GIT infrastructure see the dedicated GIT infrastructure page.