(→Community management) |
(→Documentation) |
||
(45 intermediate revisions by 19 users not shown) | |||
Line 1: | Line 1: | ||
− | This page is intended to be a summary of the tools used by the KDE | + | |
− | project for Software Engineering tasks, i.e. everything around coding work. This includes bugfixing, review, testing, documentation, requirements etc. | + | |
+ | This page is intended to be a summary of the tools and processes used by the KDE | ||
+ | project for Software Engineering tasks, i.e. everything around coding | ||
+ | work. This includes bugfixing, review, testing, documentation, | ||
+ | requirements etc. | ||
The current tool used by KDE should be listed along with the extent of | The current tool used by KDE should be listed along with the extent of | ||
Line 6: | Line 10: | ||
− | == | + | == Development Tools == |
− | = | + | {{SEFBox |
− | [http://websvn.kde.org/ Subversion | + | | name=Source Control |
+ | | currentState= | ||
+ | * [http://websvn.kde.org/ Subversion] (Moving to Git) | ||
+ | * [https://projects.kde.org/ KDE Projects]: Git repository browser. | ||
+ | * [http://quickgit.kde.org/ KDE QuickGit]: Git source code browser. | ||
+ | | people= | ||
+ | The kde sysadmin team: | ||
+ | * [http://wire.dattitu.de/authors/2-Dirk Dirk Müller] | ||
+ | * [http://www.kdab.net/~dfaure/ David Faure] | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-scm-interest}} | ||
+ | }} | ||
− | + | Subversion is currently used for source control management in KDE on | |
− | + | a server hosted in Frankfurt. A separate server is used for access to | |
+ | the read-only mirror anonsvn.kde.org. | ||
− | + | There is begun migrating to Git, see [[Projects/MovetoGit|Move to Git]]. A guide to KDE Git infrastructure can be found on the [http://community.kde.org/Sysadmin/GitKdeOrgManual Git.kde.org Manual]. | |
− | There is | + | |
− | + | ||
− | [http:// | + | |
− | + | ||
− | = | + | {{SEFBox |
− | * [http:// | + | | name=Build System |
− | * [http:// | + | | currentState= |
− | * [http://www. | + | * [http://www.cmake.org/ CMake] |
+ | * [http://api.kde.org/cmake/modules.html Custom CMake module documentation] | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-buildsystem}} | ||
+ | | people= | ||
+ | * [http://www.kdedevelopers.org/blog/531 Alexander Neundorf] | ||
+ | }} | ||
− | + | CMake is the build tool currently used by KDE. It is Free Software | |
− | + | developed by [http://www.kitware.com/ kitware inc] and available on | |
− | + | multiple platforms supported by KDE. | |
− | + | This tool was chosen as the buildsystem for the KDE SC 4 series, and there | |
− | + | are no plans currently to migrate away from it. | |
− | == | + | {{SEFBox |
− | + | | name=Identifier search | |
+ | | currentState= | ||
+ | http://lxr.kde.org | ||
+ | | people= | ||
+ | The kde sysadmin team: | ||
+ | * [http://wire.dattitu.de/authors/2-Dirk Dirk Müller] | ||
+ | * [http://www.kdab.net/~dfaure/ David Faure] | ||
+ | }} | ||
− | + | [http://en.wikipedia.org/wiki/LXR_Cross_Referencer LXR] indexes classes and methods used in KDE. This can be useful for finding examples of how to use a class, and finding all uses of a class while refactoring or updating API. | |
− | + | ||
− | == Patch review (pre commit) | + | == Review == |
− | = | + | {{SEFBox |
− | + | | name=Patch review (pre commit) | |
− | + | | currentState= | |
− | + | * [https://projects.kde.org/projects/kdereview KDE Review Module] | |
− | [ | + | * [[Development/Review_Board|KDE Review Board]] |
+ | | people= | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-core-devel}}: Discuss KDE patch review and tools | ||
+ | }} | ||
− | + | In general KDE does not have a formal patch review policy for individual | |
− | + | patches. Some patches do get reviewed prior to committing to svn by the | |
+ | relevant mailing lists or on the Review Board. This is the case for particularly large patches or patches by new developers. | ||
− | + | As an official policy kdereview is used to review new applications and | |
− | + | new classes for kdelibs prior to inclusion in KDE trunk. See [[Policies/Application_Lifecycle#Stage_2:_Stable|Application Lifecycle]] for some more details. | |
− | + | ||
− | + | ||
− | + | A drawback of this system is that not all reviewers report that they have reviewed the new content. It may make sense to have a checklist for reviewers to use, eg, | |
− | + | ||
− | + | * All new classes documented [x] | |
− | + | * Private classes and d-pointers used where appropriate [x] | |
+ | * Passes all krazy checks [ ] | ||
+ | * No obvious security concerns [ ] | ||
+ | * Designed well/maintainable [ ] | ||
+ | * etc... | ||
− | + | This was discussed to some extent [http://thread.gmane.org/gmane.comp.kde.devel.core/54213 here], but has not yet been refined into a techbase page. | |
− | + | ||
− | + | ||
+ | {{SEFBox | ||
+ | | name=Commit review (after commit) | ||
+ | | currentState= | ||
+ | * {{KDEML|kde-commits}} mailing list records all commits to KDE svn. | ||
+ | * The [http://commitfilter.kde.org/ CommitFilter] is used to filter relevant commits based on path of the commit. | ||
+ | * SVN <tt>CCMAIL:</tt> feature used to notify relevant mailing lists or individuals of specific commits. | ||
+ | * SVN <tt>BUG:</tt> feature used to close bugs, and also notifies all bug subscribers of the commit. | ||
+ | * SVN <tt>CCBUG:</tt> feature used to notify closed bugs of updates. Commonly used when porting fixes between branches. Also notifies all bug subscribers of the commit. | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-commits}} | ||
+ | | altTools= | ||
+ | * Unknown | ||
+ | }} | ||
− | + | The commit filter is used by several projects to forward all commits to the relevant mailing list. | |
− | + | ||
− | + | ||
− | |||
− | |||
− | = | + | {{SEFBox |
− | * | + | | name=Design Review |
+ | | currentState= | ||
+ | Design review takes place on | ||
+ | * mailing lists | ||
+ | * project wikis | ||
+ | * face-to-face/BOF sessions and sprints | ||
+ | * kdereview | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-core-devel}} is used to announce new additions to kdereview. | ||
+ | }} | ||
− | + | KDE does not have an offical design review process. Some design review takes place as part of the kdereview process. It may be possible to further formalise this or encourage design documentation. | |
− | + | ||
− | + | ||
− | === | + | == Documentation == |
− | + | ||
− | = | + | {{SEFBox |
− | + | | name=Technical documentation | |
+ | | currentState= | ||
+ | * http://techbase.kde.org | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-www}} | ||
+ | | people= | ||
+ | * [[User:Danimo|Danimo]] is the MediaWiki admin for techbase.kde.org. | ||
+ | | futureWork= | ||
+ | }} | ||
− | + | techbase.kde.org is a [http://www.mediawiki.org MediaWiki] powered site used for collaborating on technical tasks such as tutorials, schedules, and project information. | |
− | + | ||
− | + | ||
− | === | + | {{SEFBox |
− | [http://www.kdedevelopers.org/blog/1451 Allen | + | | name=API documentation |
+ | | currentState= | ||
+ | * [http://www.stack.nl/~dimitri/doxygen/ Doxygen] is used to generate api documentation from documentation strings in code. | ||
+ | | getInvolved= | ||
+ | * [[Development/Tutorials/API_Documentation|APIDOX tutorials]] Make KDE API docs better. | ||
+ | | people= | ||
+ | * [http://www.kdedevelopers.org/blog/1451 Allen Winter] administers api.kde.org. | ||
+ | | altTools= | ||
+ | * [http://labs.trolltech.com/blogs/2008/06/20/introducing-doxygen2qthelp-create-qch-files-from-doxygen-finally/ doxygen2qthelp] used by trolltech to create qt documentation. | ||
+ | }} | ||
− | + | KDE API documentation is generated nightly and hosted on http://api.kde.org. It is also possible to generate the same documentation locally for use in an IDE for example. | |
− | + | ||
− | + | It is possible to create [http://www.kdedevelopers.org/node/3010 man pages] and [http://thread.gmane.org/gmane.comp.kde.devel.core/55578 qthelp documentation] from kde sources. | |
− | + | ||
− | + | ||
+ | {{SEFBox | ||
+ | | name=User documentation | ||
+ | | currentState= | ||
+ | * http://userbase.kde.org | ||
+ | * [http://i18n.kde.org/docs/doc-primer/check-docs.html meinproc] is used to generate user documentation. | ||
+ | * {{KDEML|kde-doc-english}} Records all SVN commits with the <tt>GUI</tt> magic word. | ||
+ | | getInvolved= | ||
+ | * http://userbase.kde.org Create tutorials and tips. | ||
+ | * {{KDEML|kde-doc-english}} Used to coordinate user documentation. | ||
+ | * {{KDEML|kde-docbook}} For technical discussions about docbook. | ||
+ | }} | ||
− | + | User documentation is generated from module doc/ folders and hosted on http://docs.kde.org. | |
− | + | ||
− | + | ||
− | + | meinproc is a KDE tool (written by Stephen Kulow which uses libxslt to transform docbook into (bzipped) html. At runtime kio_help opens that bzipped html and displays it to the user in khelpcenter. | |
− | + | ||
− | + | http://userbase.kde.org is intended to be the primary source of user documentation on the web. Content will possibly be packaged for offline use in the future. | |
− | + | ||
− | == | + | == Testing and Quality == |
− | = | + | {{SEFBox |
− | * | + | | name=Bug tracking |
− | * | + | | currentState= |
+ | * [http://bugs.kde.org/ Bugzilla 3.0.x]. | ||
+ | * KBugBuster | ||
+ | | people= | ||
+ | * [http://mattr.info:8080/blog/?s=bugzilla Matt Rogers] and the KDE sysadmin team maintain the KDE bugzilla installation. | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-core-devel}} Discuss alternative bug trackers for KDE. | ||
+ | * {{KDEML|kde-bugs-dist}} Records all updates on bugs.kde.org. | ||
+ | * {{KDEML|kdelibs-bugs}} Records all updates to kdelibs bugs. | ||
+ | * {{KDEML|konq-bugs}} Records all updates to konqueror bugs. | ||
+ | * {{KDEML|kdevelop-bugs}} Records all updates to kdevelop bugs. | ||
+ | * {{KDEML|amarok-bugs-dist}} Records all updates to amarok bugs. | ||
+ | | altTools= | ||
+ | * https://bugs.launchpad.net, [http://www.sourcecode.de/content/leonov-launchpad-desktop-client-first-coming Leonev] | ||
+ | * [http://trac.edgewall.org/ trac] | ||
+ | * [http://www.redmine.org/ Redmine] - kind of "Trac on Rails" | ||
+ | }} | ||
− | + | Bug tracking in KDE currently is managed using Bugzilla 3.0. Work was recently merged on a transition to Bugzilla 3.0 from Bugzilla 2.16. There is still cleanup work going on but most features of the previous Bugzilla installation already work. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | Bugzilla can be difficult to use and daunting to newbies. | |
− | + | ||
− | + | ||
+ | {{SEFBox | ||
+ | | name=Static code analysis | ||
+ | | currentState= | ||
+ | * [http://www.englishbreakfastnetwork.org/krazy/ Krazy] hosted at EnglishBreakfastNetwork (EBN). | ||
+ | * [http://www.coverity.com/ Coverity] is used to find possible sources of defects and suggested optimizations. Results are displayed per module as part of [http://ktown.kde.org/~dirk/dashboard/ Dirks Dashboard builds]. | ||
+ | | people= | ||
+ | * [http://people.fruitsalad.org/adridg/bobulate/ Adriaan de Groot] | ||
+ | * [http://www.kdedevelopers.org/blog/1451 Allen Winter] | ||
+ | | getInvolved= | ||
+ | * | ||
+ | }} | ||
− | + | Additional checks are always welcome for adding to Krazy. See http://websvn.kde.org/trunk/quality/. | |
− | + | ||
− | + | ||
− | = | + | {{SEFBox |
− | + | | name=Build testing | |
− | http:// | + | | currentState= |
+ | * [http://developer.kde.org/~dirk/dashboard/ Continuous build server] reports broken builds on linux. | ||
+ | * [http://my.cdash.org/index.php?project=kdelibs CDash build server] stores results of Nightly builds for KDE modules. | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-core-devel}} Find out how to submit test build results. | ||
+ | | people= | ||
+ | * [http://wire.dattitu.de/authors/2-Dirk Dirk Mueller] maintains the dashboard | ||
+ | * Bill Hoffman is involved with the CDash service provided by Kitware. | ||
+ | * http://www.cdash.org/mailinglist.html | ||
+ | }} | ||
+ | There is interest in more build testing for KDE especially on non-linux platforms. Improvements include some standard ctest scripts that can be used to build and submit a dashboard result for kdelibs to CDash. This would be run on a cronjob for simplicity. | ||
− | + | Builds are planned for the following platforms: | |
− | + | ||
− | + | ||
− | + | ||
− | + | * Windows | |
− | + | * MacOS | |
+ | * FreeBSD 6 (gcc) | ||
+ | * FreeBSD 7 (gcc) | ||
+ | * Solaris (S10, S11) on SPARC and amd64 | ||
− | = | + | {{SEFBox |
− | + | | name=Unit testing | |
− | + | | currentState= | |
+ | [[Development/Tutorials/Unittests|Unit tests]] may be written with the QTest framework. Tests can be run with the command '<tt>make test</tt>'. | ||
+ | | getInvolved= | ||
+ | * [[Development/Tutorials/Unittests|Techbase Unit tests tutorial]] | ||
+ | }} | ||
− | == | + | It may be possible run run these tests automatically possibly on EBN or on Dirks dashboard. |
− | [http://people.fruitsalad.org/adridg/bobulate/ Adriaan de Groot] | + | |
+ | {{SEFBox | ||
+ | | name=Quality testing | ||
+ | | currentState= | ||
+ | * The early adopter/user community | ||
+ | * [http://www.sqo-oss.eu/news/coverage/sqo-oss-project-launched-with-kde SQO-OSS] | ||
+ | | people= | ||
+ | * [http://people.fruitsalad.org/adridg/bobulate/ Adriaan de Groot] | ||
+ | * [http://hemswell.lincoln.ac.uk/~padams/index.php Paul Adams] | ||
+ | | getInvolved= | ||
+ | }} | ||
− | |||
It may be possible to obtain metrics such as bugs per kloc, defect injection rate etc. | It may be possible to obtain metrics such as bugs per kloc, defect injection rate etc. | ||
− | == | + | {{SEFBox |
− | === | + | | name=Profiling and Optimizations |
− | + | | currentState= | |
+ | * {{KDEML|kde-optimize}} mailing list coordinates optimizations in KDE. | ||
+ | * Krazy and Coverity tools also include some optimization checks. | ||
+ | * KDE macros for optimization of common algorithms. | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-optimize}} | ||
+ | * [http://ktown.kde.org/~dirk/dashboard/4.1/i386/kdelibs.html Coverity report for KDE libs]. | ||
+ | }} | ||
+ | |||
+ | Tutorials may be provided in the future to help developers optimize their code. | ||
+ | |||
+ | {{SEFBox | ||
+ | | name=Accessibility and Usability | ||
+ | | currentState= | ||
+ | * http://usability.kde.org/ | ||
+ | * http://openusability.org/projects.php | ||
+ | * Season of usability | ||
+ | | people= | ||
+ | * [http://weblog.obso1337.org/ Celeste Lyn Paul] | ||
+ | * [http://ellen.reitmayr.net/index.php/blog Ellen Reitmayr] | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-usability}} | ||
+ | * [[Projects/Usability/HIG|KDE Human interaction Guidelines]]. | ||
+ | }} | ||
+ | |||
+ | {{SEFBox | ||
+ | | name=Research | ||
+ | | currentState= | ||
+ | * http://research.kde.org | ||
+ | * [http://www.sqo-oss.eu/news/coverage/sqo-oss-project-launched-with-kde SQO-OSS] | ||
+ | * http://nepomuk.kde.org/ Semantic desktop project funded by the EU. | ||
+ | | people= | ||
+ | * [http://people.fruitsalad.org/adridg/bobulate/ Adriaan de Groot] | ||
+ | * [http://www.kdedevelopers.org/blog/2904 Sebastian Trueg] leads the kde-nepomuk project. | ||
+ | | getInvolved= | ||
+ | * [http://lists.semanticdesktop.org/mailman/listinfo/nepomuk-kde Nepomuk KDE mailing list] | ||
+ | }} | ||
+ | |||
+ | == Marketing and Expectations == | ||
+ | {{SEFBox | ||
+ | | name=Requirements Gathering | ||
+ | | currentState= | ||
+ | * Requirements come from user feedback on http://bugs.kde.org and from commercial interests. | ||
+ | * Developers may do some research into requirements for applications based on User Research Profiles. | ||
+ | | getInvolved= | ||
+ | * http://bugs.kde.org Fill new wishlist items. | ||
+ | * {{KDEML|kde-core-devel}} Discuss new ways for kde to gather requirements. | ||
+ | }} | ||
+ | |||
+ | {{SEFBox | ||
+ | | name=Promotion | ||
+ | | currentState= | ||
+ | * The {{KDEML|kde-promo|KDE marketing team}} manage marketing and promotion from official kde sources. | ||
+ | * http://dot.kde.org is the community forum around promotional announcements. | ||
+ | * http://www.kde.org/announcements is the official source of promotional announcements regarding KDE. | ||
+ | * Design and maintenance of KDE websites is organised on the [https://mail.kde.org/mailman/listinfo/kde-www kde-www mailing list] | ||
+ | * The [http://ev.kde.org/workinggroups/mwg.php Marketing working group] coordinates several marketing efforts such as promoting planning and branding. | ||
+ | * KDE e.v provides a booth box for conference booths containing posters, leaftlets and other information needed at a conference stand. | ||
+ | | people= | ||
+ | * [http://wadejolson.wordpress.com/ Wade Olsen] | ||
+ | * [http://troy-at-kde.livejournal.com/ Troy Unrau] | ||
+ | * [http://nowwhatthe.blogspot.com/ Jos Poortvliet] | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-promo}} | ||
+ | * [http://dot.kde.org/addPostingForm Submit dot articles] | ||
+ | }} | ||
+ | |||
+ | {{SEFBox | ||
+ | | name=Community management | ||
+ | | currentState= | ||
+ | * The Community Working Group helps with community advice when needed | ||
+ | * [http://www.kde.org/code-of-conduct/ Code of Conduct] Based on the Ubuntu Code of Conduct, documents guidelines for acceptable behaviour within the community. Can be summarized as 'Be Excellent to Eachother'. | ||
+ | * http://community.kde.org. In development website. | ||
+ | | people= | ||
+ | * Anne Willson | ||
+ | * [http://jucato.org Juan Carlos Torres] | ||
+ | * [http://lydiapintscher.de Lydia Pintscher] | ||
+ | * Martin Fitzpatrick | ||
+ | * [http://omat.nl Tom Albers] | ||
+ | | getInvolved= | ||
+ | * Send an e-mail to community-wg@kde.org | ||
+ | }} | ||
+ | |||
+ | {{SEFBox | ||
+ | | name=Communication | ||
+ | | currentState= | ||
+ | Developers communicate with each other through | ||
+ | * [http://lists.kde.org/ mailing lists] | ||
+ | * [http://searchirc.com/irc-kde-1 IRC] | ||
+ | * [http://planetkde.org Blogs] | ||
+ | * Conferences | ||
+ | Developers communicate with users though | ||
+ | * [http://planetkde.org Blogs] to some extent (mainly early adopting users). | ||
+ | * [http://forum.kde.org Forums] to some extent where the developer chooses to. | ||
+ | * [http://dot.kde.org News announcements] | ||
+ | Users communicate with each other and developers through | ||
+ | * [http://forum.kde.org Forums] | ||
+ | * {{KDEML|kde}} mailing list | ||
+ | * #kde irc channel. | ||
+ | | people= | ||
+ | * [http://c133.org/blog/ Chris Lee] administers planetkde.org | ||
+ | | getInvolved= | ||
+ | * Add your blog to planet kde if you contribute to KDE in some way, including development, testing, advocacy, translation, documentation etc. | ||
+ | }} | ||
+ | |||
+ | == Release == | ||
+ | {{SEFBox | ||
+ | | name=Release Scheduling | ||
+ | | currentState= | ||
+ | * Maintained at [[Schedules]]. | ||
+ | | people= | ||
+ | * | ||
+ | * [http://cyrilleberger.blogspot.com/ Cyrill Berger] - KOffice release coordinator. | ||
+ | * [http://www.kdedevelopers.org/blog/1451 Allen Winter] - KDEPIM release coordinator. | ||
+ | | getInvolved= | ||
+ | * {{KDEML|release-team}} | ||
+ | }} | ||
+ | |||
+ | {{SEFBox | ||
+ | | name=Feature planning | ||
+ | | currentState= | ||
+ | * [[Schedules/KDE4/4.6_Feature_Plan]] | ||
+ | | people= | ||
+ | [https://mail.kde.org/mailman/listinfo/release-team The KDE release team] | ||
+ | | altTools= | ||
+ | * Launchpad.net offers a blueprints system. | ||
+ | * [http://wiki.pentaho.com/display/OpenScrum/Home Scrum in Open Source Projects] | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-core-devel}} - Discuss the KDE approach to feature planning. | ||
+ | }} | ||
− | + | Currently techbase is used for feature planning but there may be better alternatives. | |
− | + | ||
− | + | ||
− | = | + | {{SEFBox |
− | + | | name=Downstream packagers and contributions | |
− | + | | currentState= | |
+ | * Many distributions package KDE3 & KDE4. | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-packagers}} - Private mailing list for packagers. Includes information relating to security releases. | ||
+ | }} | ||
− | === | + | == Theming and Translations == |
+ | {{SEFBox | ||
+ | | name=Artwork | ||
+ | | currentState= | ||
+ | * The {{KDEML|kde-artists|kde-artists team}} creates offical artwork for KDE. | ||
+ | * [http://kde-look.org kde-look.org] for non-offical artwork. | ||
+ | | people= | ||
* [http://pinheiro-kde.blogspot.com/ Nuno Pinheiro] | * [http://pinheiro-kde.blogspot.com/ Nuno Pinheiro] | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-artists}} | ||
+ | }} | ||
− | + | Additional contributed artwork is available on kde-look.org. | |
− | + | ||
− | + | There may be a need to create tutorials on how to create artwork for kde. | |
− | + | ||
− | + | ||
− | + | ||
− | = | + | {{SEFBox |
− | + | | name=Translation | |
− | * http:// | + | | currentState= |
− | * http:// | + | * http://l10n.kde.org/ is used for level of completion of translations in KDE. |
− | * | + | * GNU gettext is used for translation in KDE. |
+ | * <tt>.po</tt> files are edited directly in KDE svn to update translations. | ||
+ | * A kde4 based translation client ([http://userbase.kde.org/Lokalize Lokalize]) is being developed in kdesdk/. | ||
+ | * Krazy includes sanity checks/plurals checking for translation. | ||
+ | | altTools= | ||
+ | launchpad.net features a web-based tool called rosetta, which allows for easier fly-by translations. This is considered not to be useful as fly-by translators often do not follow guidelines or consistency rules when translating. | ||
+ | | getInvolved= | ||
+ | * {{KDEML|kde-i18n-doc}} | ||
+ | }} | ||
− | === | + | == Legal And Support == |
− | * [http:// | + | {{SEFBox |
− | * [http:// | + | | name=KDE e.v. - Representative Legal Entity |
+ | | currentState= | ||
+ | * [http://ev.kde.org KDE e.v.] is a registered non-profit organization that represents the KDE Project in legal and financial matters. | ||
+ | | getInvolved= | ||
+ | * [http://ev.kde.org/getinvolved/ KDE e.v. membership] | ||
+ | * [http://jointhegame.kde.org/ Join the Game] | ||
+ | }} | ||
− | = | + | {{SEFBox |
− | + | | name=Resolving licencing issues. | |
− | [http:// | + | | currentState= |
+ | * A [http://ev.kde.org/announcements/2008-08-22-fsfe-welcomes-fla.php Fiduicary Licence Agreement] is available, which will allow KDE developers to optionally assign copyright of their contributions to KDE e.v. This would allow easier relicencing of contributors content in the event that KDE needs to move to another licence. It also allows the e.v. to more easily represent the work in the unlikely event of a court dispute involving KDE code. | ||
+ | * [[Policies/Licensing_Policy|KDE licencing policy]] allows commercial and non-commercial development and proprietry and non-proprietry development. | ||
+ | * [[Projects/KDE_Relicensing|Projects/KDE_Relicensing]] Effort to relicence KDE code to use version 3 of GNU GPL and LGPL. This work is unfinished but not still being performed. Many contributors are no longer contactable. | ||
+ | }} | ||
− | == | + | {{SEFBox |
− | [http:// | + | | name=Sponsorship and Patronship |
+ | | currentState= | ||
+ | * [http://ev.kde.org/supporting-members.php Supporters of KDE] contribute sponsorship money to KDE e.v. | ||
+ | | getInvolved= | ||
+ | * [http://ev.kde.org/getinvolved/supporting-members.php Become a supporting member] | ||
+ | }} |
This page is intended to be a summary of the tools and processes used by the KDE
project for Software Engineering tasks, i.e. everything around coding
work. This includes bugfixing, review, testing, documentation,
requirements etc.
The current tool used by KDE should be listed along with the extent of its use, known alternatives, and advantages/disadvantages.
Current State | People |
|
The kde sysadmin team: |
Get Involved | Alternative Tools |
n/a |
Subversion is currently used for source control management in KDE on a server hosted in Frankfurt. A separate server is used for access to the read-only mirror anonsvn.kde.org.
There is begun migrating to Git, see Move to Git. A guide to KDE Git infrastructure can be found on the Git.kde.org Manual.
Current State | People |
Get Involved | Alternative Tools |
n/a |
CMake is the build tool currently used by KDE. It is Free Software developed by kitware inc and available on multiple platforms supported by KDE.
This tool was chosen as the buildsystem for the KDE SC 4 series, and there are no plans currently to migrate away from it.
Current State | People |
The kde sysadmin team: | |
Get Involved | Alternative Tools |
n/a |
n/a |
LXR indexes classes and methods used in KDE. This can be useful for finding examples of how to use a class, and finding all uses of a class while refactoring or updating API.
Current State | People |
Get Involved | Alternative Tools |
|
n/a |
In general KDE does not have a formal patch review policy for individual patches. Some patches do get reviewed prior to committing to svn by the relevant mailing lists or on the Review Board. This is the case for particularly large patches or patches by new developers.
As an official policy kdereview is used to review new applications and new classes for kdelibs prior to inclusion in KDE trunk. See Application Lifecycle for some more details.
A drawback of this system is that not all reviewers report that they have reviewed the new content. It may make sense to have a checklist for reviewers to use, eg,
This was discussed to some extent here, but has not yet been refined into a techbase page.
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
|
The commit filter is used by several projects to forward all commits to the relevant mailing list.
Current State | People |
Design review takes place on
|
Unknown |
Get Involved | Alternative Tools |
|
n/a |
KDE does not have an offical design review process. Some design review takes place as part of the kdereview process. It may be possible to further formalise this or encourage design documentation.
Current State | People |
| |
Get Involved | Alternative Tools |
n/a |
techbase.kde.org is a MediaWiki powered site used for collaborating on technical tasks such as tutorials, schedules, and project information.
Current State | People |
|
|
Get Involved | Alternative Tools |
|
|
KDE API documentation is generated nightly and hosted on http://api.kde.org. It is also possible to generate the same documentation locally for use in an IDE for example.
It is possible to create man pages and qthelp documentation from kde sources.
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
|
n/a |
User documentation is generated from module doc/ folders and hosted on http://docs.kde.org.
meinproc is a KDE tool (written by Stephen Kulow which uses libxslt to transform docbook into (bzipped) html. At runtime kio_help opens that bzipped html and displays it to the user in khelpcenter.
http://userbase.kde.org is intended to be the primary source of user documentation on the web. Content will possibly be packaged for offline use in the future.
Current State | People |
|
|
Get Involved | Alternative Tools |
|
|
Bug tracking in KDE currently is managed using Bugzilla 3.0. Work was recently merged on a transition to Bugzilla 3.0 from Bugzilla 2.16. There is still cleanup work going on but most features of the previous Bugzilla installation already work.
Bugzilla can be difficult to use and daunting to newbies.
Current State | People |
|
|
Get Involved | Alternative Tools |
|
n/a |
Additional checks are always welcome for adding to Krazy. See http://websvn.kde.org/trunk/quality/.
Current State | People |
|
|
Get Involved | Alternative Tools |
|
n/a |
There is interest in more build testing for KDE especially on non-linux platforms. Improvements include some standard ctest scripts that can be used to build and submit a dashboard result for kdelibs to CDash. This would be run on a cronjob for simplicity.
Builds are planned for the following platforms:
Current State | People |
Unit tests may be written with the QTest framework. Tests can be run with the command 'make test'. |
Unknown |
Get Involved | Alternative Tools |
n/a |
It may be possible run run these tests automatically possibly on EBN or on Dirks dashboard.
Current State | People |
|
|
Get Involved | Alternative Tools |
n/a |
It may be possible to obtain metrics such as bugs per kloc, defect injection rate etc.
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
n/a |
Tutorials may be provided in the future to help developers optimize their code.
Current State | People |
|
|
Get Involved | Alternative Tools |
n/a |
Current State | People |
|
|
Get Involved | Alternative Tools |
n/a |
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
|
n/a |
Current State | People |
|
|
Get Involved | Alternative Tools |
n/a |
Current State | People |
|
|
Get Involved | Alternative Tools |
|
n/a |
Current State | People |
Developers communicate with each other through
Developers communicate with users though
Users communicate with each other and developers through |
|
Get Involved | Alternative Tools |
|
n/a |
Current State | People |
|
|
Get Involved | Alternative Tools |
n/a |
Current State | People |
Get Involved | Alternative Tools |
|
|
Currently techbase is used for feature planning but there may be better alternatives.
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
|
n/a |
Current State | People |
|
|
Get Involved | Alternative Tools |
n/a |
Additional contributed artwork is available on kde-look.org.
There may be a need to create tutorials on how to create artwork for kde.
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
launchpad.net features a web-based tool called rosetta, which allows for easier fly-by translations. This is considered not to be useful as fly-by translators often do not follow guidelines or consistency rules when translating. |
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
n/a |
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
n/a |
n/a |
Current State | People |
|
Unknown |
Get Involved | Alternative Tools |
n/a |