Difference between revisions of "Contribute"

Jump to: navigation, search
(Marked this version for translation)
Line 1: Line 1:
 
<languages />
 
<languages />
 
<translate>
 
<translate>
 +
<!--T:1-->
 
{{Template:I18n/Language Navigation Bar|Contribute}}
 
{{Template:I18n/Language Navigation Bar|Contribute}}
 
This page intends to give an overview of the different aspects of KDE development in particular for programming related issues. ''The KDE project welcomes anyone willing to help''.
 
This page intends to give an overview of the different aspects of KDE development in particular for programming related issues. ''The KDE project welcomes anyone willing to help''.
  
 +
<!--T:2-->
 
{{Note|There are a lot of ways to get involved in KDE development, which can be summed up in several categories:
 
{{Note|There are a lot of ways to get involved in KDE development, which can be summed up in several categories:
 
:''Documentation, Translation, Development, Usability, Accessibility, Artwork, Promotion
 
:''Documentation, Translation, Development, Usability, Accessibility, Artwork, Promotion
Line 9: Line 11:
 
}}
 
}}
  
== News and Mail Sources ==
+
== News and Mail Sources == <!--T:3-->
  
 +
<!--T:4-->
 
The general direction of the KDE project is determined by those who do the work - there is no single high level plan for what KDE will look like in the future.
 
The general direction of the KDE project is determined by those who do the work - there is no single high level plan for what KDE will look like in the future.
  
 +
<!--T:5-->
 
If you want to find out what is currently happening, then there are a number of sources you might like to consider:
 
If you want to find out what is currently happening, then there are a number of sources you might like to consider:
 
; [http://www.kde.org/mailinglists/ Mailing Lists]
 
; [http://www.kde.org/mailinglists/ Mailing Lists]
 
: Probably the best way to find out what's going on in KDE development. Archives are available [http://lists.kde.org here]
 
: Probably the best way to find out what's going on in KDE development. Archives are available [http://lists.kde.org here]
  
 +
<!--T:6-->
 
; [http://commitfilter.kde.org/ CommitFilter]
 
; [http://commitfilter.kde.org/ CommitFilter]
 
: Receive notification of commits to the KDE source code repositories in areas that interest you.
 
: Receive notification of commits to the KDE source code repositories in areas that interest you.
  
 +
<!--T:7-->
 
; [http://commit-digest.org/ KDE Commit-Digest]
 
; [http://commit-digest.org/ KDE Commit-Digest]
 
: Weekly summary of commits to projects in the KDE source code repositories.
 
: Weekly summary of commits to projects in the KDE source code repositories.
  
 +
<!--T:8-->
 
; [http://dot.kde.org/ The Dot]
 
; [http://dot.kde.org/ The Dot]
 
: The KDE news site.
 
: The KDE news site.
  
== Reporting Bugs ==
+
== Reporting Bugs == <!--T:9-->
  
 +
<!--T:10-->
 
The easiest way to contribute to KDE is to [http://userbase.kde.org/Asking_Questions#Reporting_KDE_Bugs report any bugs] you find in KDE using the [https://bugs.kde.org/ KDE Bug Tracking System] (also known as '''Bugzilla''').
 
The easiest way to contribute to KDE is to [http://userbase.kde.org/Asking_Questions#Reporting_KDE_Bugs report any bugs] you find in KDE using the [https://bugs.kde.org/ KDE Bug Tracking System] (also known as '''Bugzilla''').
  
 +
<!--T:11-->
 
If the application you are using crashes then the '''Dr Konqi''' utility will appear and guide you through the process of reporting the crash.  Learn more by reading  [[Development/Tutorials/Debugging/How_to_create_useful_crash_reports|how to create useful crash reports]].
 
If the application you are using crashes then the '''Dr Konqi''' utility will appear and guide you through the process of reporting the crash.  Learn more by reading  [[Development/Tutorials/Debugging/How_to_create_useful_crash_reports|how to create useful crash reports]].
  
== Getting Started with Coding ==
+
== Getting Started with Coding == <!--T:12-->
  
 +
<!--T:13-->
 
Getting started at coding for KDE is a matter of finding something to fix, and fixing it. You may want to consult the module overview to help find what you are looking for; once you have fixed something, you will want to send in a patch. If you do that a few times, you may want to apply for a KDE Contributor account so you can improve things directly.
 
Getting started at coding for KDE is a matter of finding something to fix, and fixing it. You may want to consult the module overview to help find what you are looking for; once you have fixed something, you will want to send in a patch. If you do that a few times, you may want to apply for a KDE Contributor account so you can improve things directly.
  
 +
<!--T:14-->
 
* [[Contribute/List of KDE Modules|Module overview]]
 
* [[Contribute/List of KDE Modules|Module overview]]
 
* [[Contribute/Send Patches|Sending patches]]
 
* [[Contribute/Send Patches|Sending patches]]
Line 41: Line 52:
 
* [[Contribute/First Steps with your KDE SVN Account|First steps with your new Contributor  account]]
 
* [[Contribute/First Steps with your KDE SVN Account|First steps with your new Contributor  account]]
  
=== C++ ===
+
=== C++ === <!--T:15-->
  
 +
<!--T:16-->
 
KDE is mostly written in C++. If you are not familiar with C++, you should do at least some work on it. There are a number of good books on C++ - an excellent source is [http://mindview.net/Books/TICPP/ThinkingInCPP2e.html Bruce Eckel's "Thinking in C++"], which is available both as a free download and as a printed document. It isn't essential to understand everything before you start in KDE, but you do need to understand basic syntax and operations.
 
KDE is mostly written in C++. If you are not familiar with C++, you should do at least some work on it. There are a number of good books on C++ - an excellent source is [http://mindview.net/Books/TICPP/ThinkingInCPP2e.html Bruce Eckel's "Thinking in C++"], which is available both as a free download and as a printed document. It isn't essential to understand everything before you start in KDE, but you do need to understand basic syntax and operations.
  
=== Qt ===
+
=== Qt === <!--T:17-->
  
 +
<!--T:18-->
 
To become proficient with KDE coding, you should understand the Qt toolkit. If you are not familiar with Qt, you should work through the tutorials included with [http://doc.qt.nokia.com/latest Qt Reference Documentation].
 
To become proficient with KDE coding, you should understand the Qt toolkit. If you are not familiar with Qt, you should work through the tutorials included with [http://doc.qt.nokia.com/latest Qt Reference Documentation].
  
 +
<!--T:19-->
 
If you need a gentler introduction to Qt, or would just like an alternative view, then you may wish to look at the [http://qt4.digitalfanatics.org/tiqt/ The Independent Qt Tutorial] (Currently offline due to book contract).
 
If you need a gentler introduction to Qt, or would just like an alternative view, then you may wish to look at the [http://qt4.digitalfanatics.org/tiqt/ The Independent Qt Tutorial] (Currently offline due to book contract).
  
 +
<!--T:20-->
 
If you prefer to learn Qt by reading a traditional book, take a look at the  [http://qt.nokia.com/developer/books/ Books about Qt page]. More suggestions on becoming familiar with Qt4 are available [http://doc.qt.nokia.com/latest/how-to-learn-qt.html How to Learn Qt page].  
 
If you prefer to learn Qt by reading a traditional book, take a look at the  [http://qt.nokia.com/developer/books/ Books about Qt page]. More suggestions on becoming familiar with Qt4 are available [http://doc.qt.nokia.com/latest/how-to-learn-qt.html How to Learn Qt page].  
  
=== KDE ===
+
=== KDE === <!--T:21-->
  
 +
<!--T:22-->
 
A range of information on KDE techniques is available in the [[Development/Tutorials|tutorial section]]. Note that some of these tutorials still target KDE3, though they should be at least partly applicable.
 
A range of information on KDE techniques is available in the [[Development/Tutorials|tutorial section]]. Note that some of these tutorials still target KDE3, though they should be at least partly applicable.
  
 +
<!--T:23-->
 
You will also find useful information on KDE coding in the [[Development/FAQs|FAQs]] section. This information may also be somewhat dated for KDE4, however much of it is broadly applicable, even outside KDE.
 
You will also find useful information on KDE coding in the [[Development/FAQs|FAQs]] section. This information may also be somewhat dated for KDE4, however much of it is broadly applicable, even outside KDE.
  
 +
<!--T:24-->
 
You can also read [[Development/Further Information#Books|KDE coding books]].
 
You can also read [[Development/Further Information#Books|KDE coding books]].
  
 +
<!--T:25-->
 
Last, but by no means least, KDE comes with extensive class (Application Programmer Interface) documentation. This is available in the
 
Last, but by no means least, KDE comes with extensive class (Application Programmer Interface) documentation. This is available in the
 
[[Development/Tutorials/API Documentation|KDE API Reference Manuals]] section, which also contains a number of useful links on how to write or update the class documentation. You can also generate these on your own machine, or refer to a more up-to-date online version at [http://api.kde.org/ API Reference].
 
[[Development/Tutorials/API Documentation|KDE API Reference Manuals]] section, which also contains a number of useful links on how to write or update the class documentation. You can also generate these on your own machine, or refer to a more up-to-date online version at [http://api.kde.org/ API Reference].
  
 +
<!--T:26-->
 
A more detailed description of the steps above is available in our [http://quality.kde.org/develop/howto/howtohack.php Programming Guide].
 
A more detailed description of the steps above is available in our [http://quality.kde.org/develop/howto/howtohack.php Programming Guide].
  
== Getting Involved in Bug Hunting and Application Quality ==
+
== Getting Involved in Bug Hunting and Application Quality == <!--T:27-->
  
 +
<!--T:28-->
 
There is a large number of applications within KDE, and not all of them have a maintainer dedicated to managing bugs and generally helping out with all the issues associated with turning some working code into a polished application.
 
There is a large number of applications within KDE, and not all of them have a maintainer dedicated to managing bugs and generally helping out with all the issues associated with turning some working code into a polished application.
  
 +
<!--T:29-->
 
If you are interested in helping out with KDE, but don't know where to start, becoming a member of the KDE Quality Team might appeal to you - see the [http://quality.kde.org Quality Team website] for more information. Note that you do not need any programming skills to become involved. In particular developers regularly publish so-called [http://community.kde.org/KDE/Junior_Jobs Junior Jobs] to encourage new contributions.
 
If you are interested in helping out with KDE, but don't know where to start, becoming a member of the KDE Quality Team might appeal to you - see the [http://quality.kde.org Quality Team website] for more information. Note that you do not need any programming skills to become involved. In particular developers regularly publish so-called [http://community.kde.org/KDE/Junior_Jobs Junior Jobs] to encourage new contributions.
  
 +
<!--T:30-->
 
Of course, you can become involved in bug hunting without being part of the KDE Quality Team - just create yourself an account on the KDE [http://bugs.kde.org bug tracking system], and start searching / sorting through the bugs. Again, you don't have to have programming skills - it helps the programmers enormously just to have a procedure that allows a bug to be consistently reproduced.
 
Of course, you can become involved in bug hunting without being part of the KDE Quality Team - just create yourself an account on the KDE [http://bugs.kde.org bug tracking system], and start searching / sorting through the bugs. Again, you don't have to have programming skills - it helps the programmers enormously just to have a procedure that allows a bug to be consistently reproduced.
  
 +
<!--T:31-->
 
The [[Contribute/Bugsquad|Bugsquad]] tries to keep track of bugs in KDE software and make sure that valid bugs are noticed by developers. You do not need any programming knowledge to be in the Bugsquad; in fact it is a great way to return something to the KDE community if you cannot program.
 
The [[Contribute/Bugsquad|Bugsquad]] tries to keep track of bugs in KDE software and make sure that valid bugs are noticed by developers. You do not need any programming knowledge to be in the Bugsquad; in fact it is a great way to return something to the KDE community if you cannot program.
  
==Getting Answers to Your Questions==
+
==Getting Answers to Your Questions== <!--T:32-->
  
 +
<!--T:33-->
 
If your question concerns KDE development, your options are pretty much the same general user ones, with some modifications:
 
If your question concerns KDE development, your options are pretty much the same general user ones, with some modifications:
 
<blockquote>
 
<blockquote>
Line 85: Line 110:
 
:* '''Search engines'''. Do not forget about your favorite search engine. One of the best search engines is Google. With Google you can also [http://groups.google.com/ search] the great bulk of Usenet news sites, which is also particularly helpful, especially for general programming and gcc-related questions.
 
:* '''Search engines'''. Do not forget about your favorite search engine. One of the best search engines is Google. With Google you can also [http://groups.google.com/ search] the great bulk of Usenet news sites, which is also particularly helpful, especially for general programming and gcc-related questions.
  
 +
<!--T:34-->
 
:* '''Read the source code'''.  http://websvn.kde.org and https://projects.kde.org/ are available to help browse code. Read some commit logs and diffs for the code you might want to work with, It adds perspective.
 
:* '''Read the source code'''.  http://websvn.kde.org and https://projects.kde.org/ are available to help browse code. Read some commit logs and diffs for the code you might want to work with, It adds perspective.
 
:* '''Ask on KDE mailing lists'''. If you still do not have an answer, try asking your question on one of the KDE mailing lists listed above.
 
:* '''Ask on KDE mailing lists'''. If you still do not have an answer, try asking your question on one of the KDE mailing lists listed above.
Line 94: Line 120:
 
</blockquote>
 
</blockquote>
  
 +
<!--T:35-->
 
A full list of KDE mailing lists is available [http://www.kde.org/mailinglists/ here] and [http://mail.kde.org/mailman/listinfo here].
 
A full list of KDE mailing lists is available [http://www.kde.org/mailinglists/ here] and [http://mail.kde.org/mailman/listinfo here].
  
 +
<!--T:36-->
 
[[Category:FAQs]]
 
[[Category:FAQs]]
 
</translate>
 
</translate>

Revision as of 20:01, 23 August 2011

Other languages:Greek 34% • ‎English 100% • ‎Spanish 40% • ‎Finnish 72% • ‎French 79% • ‎Galician 100% • ‎Japanese 56% • ‎Korean 51% • ‎Dutch 98% • ‎Polish 95% • ‎Brazilian Portuguese 95% • ‎Slovak 13% • ‎Chinese (China) 96%


Contents

Contribute

This page intends to give an overview of the different aspects of KDE development in particular for programming related issues. The KDE project welcomes anyone willing to help.

noframe
 
Note
There are a lot of ways to get involved in KDE development, which can be summed up in several categories:
Documentation, Translation, Development, Usability, Accessibility, Artwork, Promotion
Not a coder? See KDE's pages on how to get involved to see other ways you can help. Also see: Bugsquad!

News and Mail Sources

The general direction of the KDE project is determined by those who do the work - there is no single high level plan for what KDE will look like in the future.

If you want to find out what is currently happening, then there are a number of sources you might like to consider:

Mailing Lists
Probably the best way to find out what's going on in KDE development. Archives are available here
CommitFilter
Receive notification of commits to the KDE source code repositories in areas that interest you.
KDE Commit-Digest
Weekly summary of commits to projects in the KDE source code repositories.
The Dot
The KDE news site.

Reporting Bugs

The easiest way to contribute to KDE is to report any bugs you find in KDE using the KDE Bug Tracking System (also known as Bugzilla).

If the application you are using crashes then the Dr Konqi utility will appear and guide you through the process of reporting the crash. Learn more by reading how to create useful crash reports.

Getting Started with Coding

Getting started at coding for KDE is a matter of finding something to fix, and fixing it. You may want to consult the module overview to help find what you are looking for; once you have fixed something, you will want to send in a patch. If you do that a few times, you may want to apply for a KDE Contributor account so you can improve things directly.

C++

KDE is mostly written in C++. If you are not familiar with C++, you should do at least some work on it. There are a number of good books on C++ - an excellent source is Bruce Eckel's "Thinking in C++", which is available both as a free download and as a printed document. It isn't essential to understand everything before you start in KDE, but you do need to understand basic syntax and operations.

Qt

To become proficient with KDE coding, you should understand the Qt toolkit. If you are not familiar with Qt, you should work through the tutorials included with Qt Reference Documentation.

If you need a gentler introduction to Qt, or would just like an alternative view, then you may wish to look at the The Independent Qt Tutorial (Currently offline due to book contract).

If you prefer to learn Qt by reading a traditional book, take a look at the Books about Qt page. More suggestions on becoming familiar with Qt4 are available How to Learn Qt page.

KDE

A range of information on KDE techniques is available in the tutorial section. Note that some of these tutorials still target KDE3, though they should be at least partly applicable.

You will also find useful information on KDE coding in the FAQs section. This information may also be somewhat dated for KDE4, however much of it is broadly applicable, even outside KDE.

You can also read KDE coding books.

Last, but by no means least, KDE comes with extensive class (Application Programmer Interface) documentation. This is available in the KDE API Reference Manuals section, which also contains a number of useful links on how to write or update the class documentation. You can also generate these on your own machine, or refer to a more up-to-date online version at API Reference.

A more detailed description of the steps above is available in our Programming Guide.

Getting Involved in Bug Hunting and Application Quality

There is a large number of applications within KDE, and not all of them have a maintainer dedicated to managing bugs and generally helping out with all the issues associated with turning some working code into a polished application.

If you are interested in helping out with KDE, but don't know where to start, becoming a member of the KDE Quality Team might appeal to you - see the Quality Team website for more information. Note that you do not need any programming skills to become involved. In particular developers regularly publish so-called Junior Jobs to encourage new contributions.

Of course, you can become involved in bug hunting without being part of the KDE Quality Team - just create yourself an account on the KDE bug tracking system, and start searching / sorting through the bugs. Again, you don't have to have programming skills - it helps the programmers enormously just to have a procedure that allows a bug to be consistently reproduced.

The Bugsquad tries to keep track of bugs in KDE software and make sure that valid bugs are noticed by developers. You do not need any programming knowledge to be in the Bugsquad; in fact it is a great way to return something to the KDE community if you cannot program.

Getting Answers to Your Questions

If your question concerns KDE development, your options are pretty much the same general user ones, with some modifications:

  • Read the Developer FAQ. Many common developer questions have been answered in the KDE Developer FAQ
  • Search/browse KDE websites. A lot of questions can also be answered from the KDE websites, and the documentation included on it. You can search all the KDE websites on the homepage. In addition, you can browse the KDE TechBase website. And if possible, help edit it for clarity, and use the talk page if something is unclear.
  • Search mailing lists. A lot of questions have already been answered on the KDE mailing lists, particular the lists kde-devel, kde2-porting, kde-core-devel, kde-games-devel, kfm-devel and koffice-devel. You can search these lists either at lists.kde.org. You should always search for your answer before asking questions on the mailing lists. When you ask a question on a mailing list you are emailing thousands of people -- please do this only if the answer is not available through a simple search.
  • Search engines. Do not forget about your favorite search engine. One of the best search engines is Google. With Google you can also search the great bulk of Usenet news sites, which is also particularly helpful, especially for general programming and gcc-related questions.

A full list of KDE mailing lists is available here and here.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal