*>Bernie |
|
| (29 intermediate revisions by 17 users not shown) |
| Line 1: |
Line 1: |
| 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.
| | {{Info|You do not need a KDE Developer account to browse source code, log into https://invent.kde.org, submit merge requests, or participate in other normal development activities. Instead, all you need is a normal '''KDE Identity Account'''; see [[Infrastructure/GitLab|GitLab]] instead.}} |
|
| |
|
| == Read-only access to git/svn ==
| | When you have been doing development work in KDE for some time and many of your merge requests or translations have been merged without drama, you may be encouraged to apply for a '''KDE Developer account.''' This will grant you the ability to do the following: |
|
| |
|
| You can checkout code anonymously without an account.
| | # Formally approve other people's merge requests |
| | # Set and change milestones and labels on merge requests and issues |
| | # Merge other people's approved merge requests, or your own |
| | # Directly push commits to change files in almost all of KDE's git and svn repositories |
|
| |
|
| == KDE Identity Account ==
| | Before you apply for a KDE Developer account, you must read, understand, and accept [[Policies/Commit Policy|the KDE commit policy]] when using your future KDE Developer account. Please also familiarize yourself with the [http://www.kde.org/code-of-conduct/ KDE Code of Conduct] which describes the social foundations within KDE, and the [https://manifesto.kde.org/ KDE Manifesto] that describes KDE's values. Holders of KDE Developer accounts are expected to uphold the highest ethical standards and not abuse the privileges they have been granted by committing controversial or un-approved changes. |
|
| |
|
| In order to request code reviews with [[Development/Review_Board|Review Board]], you'll need a '''KDE Identity Account'''. Go to [https://identity.kde.org/ https://identity.kde.org/] and create an account if you don't have one already.
| | Once you plan to contribute to KDE over the long term, and are ready to assume these responsibilities, visit the [https://identity.kde.org/index.php?r=developerApplication Developer Application page] to submit your application. |
|
| |
|
| 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 [http://websvn.kde.org WebSVN] and [http://quickgit.kde.org GIT]) so you will unfortunately get some spam as a result.
| | The form there will ask you a series of questions, including ''Why do you want an account?'', where you can explain what you want to do with your future KDE Developer account and why it's not enough to let other people merge your merge requests for you. List your sponsor who encouraged you to apply. They will also get an email to verify your request. |
|
| |
|
| Also note that this email address should be the same one that you use on [http://bugs.kde.org bugs.kde.org]. If you don't have an account in [http://bugs.kde.org 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 Contributor account and [http://bugs.kde.org bugs.kde.org] accounts match.
| | KDE's sysadmins have the last word about whether or not to approve a KDE Developer account for somebody. |
| | |
| After that, you must choose a username for your KDE Contributor 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: <tt>[email protected]</tt>. (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, [http://www.kdemail.net 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 [https://identity.kde.org/index.php?r=developerApplication Developer Application page] to apply for a KDE Contributor 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 [[Development/Git|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 [http://websvn.kde.org/trunk/kde-common/accounts kde-common/accounts]. That is the list of all accounts. Yes, '''the account list is public''', for example on [http://websvn.kde.org WebSVN].
| |
| | |
| == Who Can Apply For a KDE Contributor Account? ==
| |
| | |
| Normally, any developer who has done some work on projects hosted by KDE can apply for a KDE Contributor 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 [[Policies/SVN Commit Policy|read the KDE commit policy]]. You must accept these rules when using your future KDE Contributor account. Please also familiarize yourself with the [http://www.kde.org/code-of-conduct/ 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 Contributor 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 SVN account for somebody''.
| |
| | |
| == SSH ==
| |
| | |
| You need an SSH public key in order to access your KDE Contributor account. If you already have one, you can skip the next subsection and go to [[#Setting up the SVN+SSH protocol|Setting up the SVN+SSH protocol]].
| |
| | |
| === Generating the SSH keys ===
| |
| | |
| To be able to use your KDE Contributor 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 [http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-keygen 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, either DSA or RSA - both are fine.
| |
| | |
| To create a new pair of keys, use <syntaxhighlight lang="bash">ssh-keygen -t dsa</syntaxhighlight> or <syntaxhighlight lang="bash">ssh-keygen -t rsa</syntaxhighlight>
| |
| | |
| There is also a type called RSA1 which was used in version 1 of the SSH protocol. See the [http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-keygen ssh documentation] for more details.
| |
| | |
| You can then accept the default filename for your key (either {{path|$HOME/.ssh/id_dsa}} or {{path|$HOME/.ssh/id_rsa}}, depending on the type of key you have chosen). 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 {{path|$HOME/.ssh/id_dsa}} and {{path|$HOME/.ssh/id_dsa.pub}} or {{path|$HOME/.ssh/id_rsa}} and {{path|$HOME/.ssh/id_rsa.pub}}, depending on the type of key you have specified.
| |
| | |
| 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 SVN account.
| |
| | |
| You should also set up <tt>ssh-agent</tt> 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 [http://mah.everybody.org/docs/ssh this one]. [http://www.gentoo.org/proj/en/keychain 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.
| |
| | |
| {{tip|
| |
| If you want to use SVN with SSH with another user than the one who created the keys, you need to copy <tt>$HOME/.ssh/id_dsa.pub</tt> and <tt>$HOME/.ssh/id_dsa</tt> or <tt>$HOME/.ssh/id_rsa.pub</tt> and <tt>$HOME/.ssh/id_rsa</tt> to the other user's <tt>$HOME/.ssh</tt> directory.
| |
| | |
| You should probably also backup those files.
| |
| }}
| |
| | |
| === 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 <tt>~/.ssh/config</tt> file. Replace USERNAME with yours.
| |
| | |
| <pre>
| |
| Host *.kde.org
| |
| User USERNAME
| |
| IdentityFile ~/.ssh/id_dsa
| |
| </pre>
| |
| | |
| 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 (<tt>*.pub</tt>).
| |
| | |
| === 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 <tt>~/.ssh/config</tt> 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.
| |
| | |
| <pre>
| |
| Host *.kde.org
| |
| User git
| |
| IdentityFile ~/.ssh/id_dsa
| |
| </pre>
| |
| | |
| 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 (<tt>*.pub</tt>).
| |
| | |
| == Apply for an account ==
| |
| | |
| Now you are ready to apply for for a KDE Contributor account. Go to [https://identity.kde.org/ 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 [https://identity.kde.org/index.php?r=developerApplication 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 SVN 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 Account ==
| |
| | |
| If you already have a KDE Contributor account but want to update the ssh key, you should go to [https://identity.kde.org/ 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 adapt your local copy to the new server. See the [[Infrastructure/First Steps with your Contributor Account|next tutorial]] for your first steps with your new account.
| |
| | |
| Please add your geographical location (what country are you in?) and other details at the [http://commit-digest.org/data/ Commit Digest data page] so that the Commit Digest can accurately reflect who is working where.
| |
