|
|
| Line 1: |
Line 1: |
| This page is an overview of how to participate in KDE project by programming. For info about how to participate in other ways see KDE community wiki for [http://kde.org/community/getinvolved/ how to get involved].
| | {{Moved To Community|Get Involved}} |
| | |
| == 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:
| |
| ; [http://www.kde.org/mailinglists/ Mailing Lists]
| |
| : Probably the best way to find out what's going on in KDE development. A full list of KDE mailing lists is available [http://mail.kde.org/mailman/listinfo here] and archives are available [http://lists.kde.org here]
| |
| | |
| ; [http://commitfilter.kde.org/ CommitFilter]
| |
| : Receive notification of commits to the KDE source code repositories in areas that interest you.
| |
| | |
| ; [http://commit-digest.org/ KDE Commit-Digest]
| |
| : Weekly summary of commits to projects in the KDE source code repositories.
| |
| | |
| ; [http://dot.kde.org/ The Dot]
| |
| : The KDE news site.
| |
| | |
| == Reporting Bugs ==
| |
| | |
| 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''').
| |
| | |
| 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 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.
| |
| | |
| * [[Contribute/List of KDE Modules|Module overview]]
| |
| * [[Contribute/Send Patches|Sending patches]]
| |
| * [[Contribute/Get a Contributor Account|Applying for a KDE Contributor Account]]
| |
| * [[Contribute/First Steps with your KDE SVN Account|First steps with your new Contributor account]]
| |
| | |
| === 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 [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 ===
| |
| | |
| 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://qt-project.org/doc/latest 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 [http://www.apress.com/9781590598313 Foundations of Qt Development].
| |
| | |
| If you prefer to learn Qt by reading a traditional book, take a look at the [http://qt-project.org/books Books about Qt page]. More suggestions on becoming familiar with Qt4 are available [http://qt-project.org/doc/qt-4.8/how-to-learn-qt.html How to Learn Qt page].
| |
| | |
| === KDE ===
| |
| | |
| 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.
| |
| | |
| 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 can also read [[Development/Further Information#Books|KDE coding books]].
| |
| | |
| 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].
| |
| | |
| A more detailed description of the steps above is available in our [http://quality.kde.org/develop/howto/howtohack.php Programming Guide].
| |
| | |
| ==== Context Help: Whatsthis ====
| |
| | |
| Context help is inseparable from the dialogs and widgets, as they are the target of the context help. In fact, in order to write context help, you have to touch programming or programming tools. Indeed, the context help is a property of widgets. In object oriented programming, a property can have different values, and behave differently depending on the value. In Qt/KDE programming, the name of the property is "whatsthis", and its value is the text the context help is going to display.
| |
| | |
| Fortunately, this task is usually not very difficult, as there are good tools to deal with user interface design, and better, you will use the knowledge acquired here later when dealing with user interface in general. Using the Qt framework (Qt is the base of KDE technology), it is possible to separate code and user interface. You have two basic cases here: the user interface is written with the general code of application (usually .cpp files) or in Qt Designer files (.ui files: it is a XML document). The second case is the best to start with, as it is simpler to work with. If you don't have Qt Designer installed, you can do so by installing the devel package of Qt from your distribution or the Qt Designer package (if your distribution has more fine grained packages).
| |
| | |
| Here you can find a detailed guide for writing whatsthis using Qt Designer and working directly with the source code: [http://bddf.ca/~aseigo/whatsthis_tutorial/ WhatsThis Tutorial], by Aaron J. Seigo.
| |
| | |
| == 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 [http://techbase.kde.org/Contribute/Quality_Team 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.
| |
| | |
| 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.
| |
| | |
| 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.
| |
| | |
| == User Interface ==
| |
| | |
| The [https://vdesign.kde.org/ KDE Visual Design group] is the central studio for KDE user interface design. Their pages on the [https://community.kde.org/KDE_Visual_Design_Group KDE Community wiki] and the very active [https://forum.kde.org/viewforum.php?f=285 Visual Design forum] are the central places to check out their work and contribute.
| |
| | |
| User interface is a very wide subject, and of course it is highly subjective. Something that seems obvious to you may seem absurd to others and vice versa. Before making a proposal or entering a discussion, make sure you are ready to state your reasoning clearly, and actively work toward finding common ground with others.
| |
| | |
| It is easy to perform a quick user interface analysis, but it is hard to convince people to change the interface. A good, convincing analysis can gain much if it incorporates information from the KDE guidelines, competing program and operational system analysis, general design principles found in many books, user testing or individual (anecdotal) feedback. It is a volunteer project, and even if everybody agree with you, someone has to implement it.
| |
| | |
| In addition to the Visual Design group, the [http://mail.kde.org/mailman/listinfo/kde-usability KDE Usability Mailing List] is very active and a good place for discussing usability concerns. Their homepage is at http://techbase.kde.org/Projects/Usability. If you are already an usability expert, please check [http://www.openusability.org/ OpenUsability.org], a project that brings open source developers and usability experts together, and is collaborating closely with KDE.
| |
| | |
| Some documents guiding documents include the [http://developer.kde.org/documentation/standards/kde/style/basics/index.html KDE User Interface Guidelines (design standards)] and [http://developer.kde.org/documentation/design/ui/index.html KDE User Interface Guidelines (design principles)].
| |
| | |
| Some projects for analysis of user interfaces may include: checking that shortcut keys are coherent across KDE applications, making sure that dialogs are directly relevant to the interaction that the user would expect, and finding users of KDE software to see how they perform common workflows.
| |
| | |
| ==Getting Answers to Your Questions==
| |
| | |
| If your question concerns KDE development, your options are pretty much the same general user ones, with some modifications:
| |
| <blockquote>
| |
| :* '''Read the Developer FAQ'''. Many common developer questions have been answered in the [[Development/FAQs|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 [http://techbase.kde.org 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 at [http://lists.kde.org/ 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 [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.
| |
| | |
| :* '''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.
| |
| :* For general questions relating to core and third-party KDE development, your first choice is [mailto:[email protected] kde-devel] [mailto:[email protected]?subject=subscribe (subscribe)]. | |
| :* For questions relating to [http://www.qt.io/ Qt development], please use the fine [http://lists.qt-project.org/mailman/listinfo Qt mailing lists].
| |
| | |
| :* For questions relating to Calligra development, see [https://mail.kde.org/mailman/listinfo/calligra-devel calligra-devel] [mailto:[email protected]?subject=subscribe (subscribe)]. Krita has a [https://mail.kde.org/mailman/listinfo/kimageshop separate mailing list.] | |
| | |
| </blockquote>
| |
| | |
| [[Category:FAQs]]
| |
