< InfrastructureRevision as of 20:55, 27 August 2017 by Mpyne (talk | contribs) (However long RB sticks around for, we've mostly transitioned to Phabricator so our notes for new devs should reflect that.)(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff) This tutorial is about how to apply for a commit account for KDE so that you may change files (code, documentation files, art, etc.) in KDE's git and svn repositories. Contents 1 Read-only access to git/svn 2 KDE Identity Account 3 How to get read-write access to git/svn 4 KDE Repositories 5 Who Can Apply For a KDE Developer Account? 6 SSH 6.1 Generating the SSH keys 6.2 Using DSA/DSS Keys 6.3 Setting up the GIT protocol 6.4 Setting up the SVN+SSH protocol 7 Apply for a KDE Developer account 8 Updating An Existing KDE Developer Account 9 And Now? Read-only access to git/svn You can checkout code anonymously without an account. KDE Identity Account In order to request code reviews with Phabricator, you'll need a KDE Identity Account. Go to https://identity.kde.org/ and create an account if you don't have one already. When you register on identity.kde.org, you will need to enter your name and an e-mail address, which has to be your own (a normal address or a KDE Mail address). Of course, do not forget that this email address becomes public (at least in GIT and WebSVN) so you will unfortunately get some spam as a result. Also note that this email address should be the same one that you use on bugs.kde.org. If you don't have an account in bugs.kde.org, please create one so that it can be given usual developer rights. Closing bug reports with keywords in commit comments only works if the email address associated with your KDE Developer account and bugs.kde.org accounts match. After that, you must choose a username for your KDE Developer account between the suggestions presented to you. Please notice it is not possible to propose something else such as a nickname, as the username must be as close as possible to someone's real name. If you ask for a KDE email address one day, this will be the base for your address. For example: [email protected]. (Note, however, that KDE email addresses are not granted so easily anymore, as too many people have ranted with a KDE address and other people thought that it was the official position of the KDE Team. In the meantime, KDE Mail was created for if you need a permanent address.) How to get read-write access to git/svn After you obtained your KDE Identity, visit the Developer Application page to apply for a KDE Developer Account. KDE Repositories To have write access to KDE's git and SVN servers, you have to use KDE's main git and SVN server. Anonymous git and SVN uses mirrors of this server. Note that SVN does not allow you to read from one server and write to another, while git does. For a tutorial on using KDE's git services, see this tutorial. To be able to write to files stored in KDE's git and SVN repositories, you need an account. An account is made up of a username (normally your family name), a password, an ssh key and an email address. The username is for getting in, the password and ssh keys are for authenticating and the email address for knowing who to contact if another developer wants to contact the account holder. A KDE commit account allows you to write to nearly anywhere in the KDE repositories with a few exceptions, such as the www module. (Of course, exceptions can be made for this as well.) Note: you can see the accounts in kde-common/accounts. That is the list of all accounts. Yes, the account list is public, for example on WebSVN. Who Can Apply For a KDE Developer Account? Normally, any developer who has done some work on projects hosted by KDE can apply for a KDE Developer account. Translators should get approval from their team leader so that they can organize how the work is being done in his/her team. Please mention the approval from the team leader when requesting the account. Please also read the KDE commit policy. You must accept these rules when using your future KDE Developer account. Please also familiarize yourself with the KDE Code of Conduct which describes the social foundations within KDE. Also please apply for an account only if you think that you will work on KDE for a somewhat longer time. If you know that you will only work for a couple of weeks and then never again, please consider not applying for a KDE Developer account but instead continue to send patches directly to developers. The limitations are not there to exclude anyone - they are there to ensure that the maintenance of accounts remains reasonable. Of course, to be clear: the KDE's sysadmins have the last word about whether or not to create a KDE Developer account for somebody. SSH You need an SSH public key in order to access your KDE Developer account. If you already have one, you can skip the next subsection and go to Setting up the GIT protocol or to Setting up the SVN+SSH protocol. Generating the SSH keys To be able to use your KDE Developer account with SSH, you need a SSH public key. Please notice that it is not a GPG (OpenPGP) key, which is completely unrelated! The password in the sense of this documentation is the public key that you are creating. For more information on how to create a pair of SSH keys, please refer to a SSH documentation or book. The command to create a pair of keys is ssh-keygen and it requires the type of key you will create (RSA key; DSA are long deprecated). To create a new pair of keys, use ssh-keygen -t rsa There is also a type called RSA1 which was used in version 1 of the SSH protocol. See the ssh documentation for more details. You can then accept the default filename for your key ($HOME/.ssh/id_rsa). After that, a passphrase is asked. It is recommended that you do not leave it blank. Now that you are finished generating your key pair, you will have two files: a private key and a public key. If you have accepted the default filename, they will be respectively $HOME/.ssh/id_rsa and $HOME/.ssh/id_rsa.pub. The private key must remain secret, do not publish it to anyone under any circumstance. The public key can be published and shall be sent when you are applying for a KDE Developer account. You should also set up ssh-agent so you do not have to type the password every time you connect via SSH. There are several tutorials available explaining how to do this, for example this one. Keychain is a program that makes this task easier. Note: if you already have an ssh key, you can just use the existing key instead of creating a new one. TipIf you want to use SVN with SSH with another user than the one who created the keys, you need to copy $HOME/.ssh/id_rsa.pub and $HOME/.ssh/id_rsa to the other user's $HOME/.ssh directory. You should probably also backup those files. Using DSA/DSS Keys Please note that recent versions of OpenSSH won't allow you to use DSA format keys by default, as it considers them insecure. If you have a DSA format key you would like to use, please generate and register a new RSA key. Nevertheless, as a temporary measure, KDE Infrastructure still permits the usage of DSA keys - but you'll need to enable usage of them locally, by adding the following line to ~/.ssh/config: PubkeyAcceptedKeyTypes ssh-dss Setting up the GIT protocol Once you created your key, you'll have to tell SSH that this one should be used for all connections to KDE's git servers. For GIT access, add the following lines to the ~/.ssh/config file. Because you always connect as user "git", you use that name for the entry User. You will be identified by the key that you use. Host *.kde.org User git IdentityFile ~/.ssh/id_rsa The linked IdentityFile must belong to the public key you send in when applying for the KDE account. But it is not the public key (*.pub). Setting up the SVN+SSH protocol Once you created your key, you'll have to tell SSH that this one should be used for all connections to KDE sites. For SVN access, add the following lines to the ~/.ssh/config file. Replace USERNAME with yours. Host *.kde.org User USERNAME IdentityFile ~/.ssh/id_rsa The linked IdentityFile must belong to the public key you send in when applying for the SVN account. But it is not the public key (*.pub). Apply for a KDE Developer account Now you are ready to apply for a KDE Developer account. Go to https://identity.kde.org/ and create a KDE Identity Account if you don't have one already (see above for the details). Then visit the Developer Application page. When applying for developer access you have to provide your public SSH key. This key will be added to your profile. You can always add more keys or delete keys you don't use anymore from your profile page on identity.kde.org. The form also holds a field Why do you want an account?, where you can explain what you want to do with your future KDE Developer account, like for example developing a certain application, making documentations or being the team leader of a translation. Also note that the form will ask you who has encouraged you to apply. He or she will also get an email to verify your request. Updating An Existing KDE Developer Account If you already have a KDE Developer account but want to update the ssh key, you should go to identity.kde.org and change the keys in your profile. And Now? After having sent the form and clicking the link in the email, you have to wait for the answer (typically within two or three days). Once you have confirmation that your account has been created, you need to make sure that you push your git changes to [email protected]/<repository> instead of git://anongit.kde.org/<repository> If the project(s) you are contributing to are hosted on KDE's Git infrastructure (which is the case now for most projects), the next steps are described in the Git page. If you want to contribute to projects which are still hosted on SVN, you find instructions for that on the SVN page Please add your geographical location (what country are you in?) and other details at the Commit Digest data page so that the Commit Digest can accurately reflect who is working where. Retrieved from "https://community.kde.org/index.php?title=Infrastructure/Get_a_Developer_Account&oldid=78251" Content is available under Creative Commons License SA 4.0 unless otherwise noted.