(→Documentation) |
|||
(14 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | + | ||
This page is intended to be a summary of the tools and processes used by the KDE | This page is intended to be a summary of the tools and processes used by the KDE | ||
Line 14: | Line 14: | ||
| name=Source Control | | name=Source Control | ||
| currentState= | | currentState= | ||
− | * [http://websvn.kde.org/ Subversion | + | * [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= | | people= | ||
The kde sysadmin team: | The kde sysadmin team: | ||
Line 21: | Line 23: | ||
| getInvolved= | | getInvolved= | ||
* {{KDEML|kde-scm-interest}} | * {{KDEML|kde-scm-interest}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | Subversion | + | Subversion is currently used for source control management in KDE on |
a server hosted in Frankfurt. A separate server is used for access to | a server hosted in Frankfurt. A separate server is used for access to | ||
the read-only mirror anonsvn.kde.org. | the read-only mirror anonsvn.kde.org. | ||
− | There is | + | 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]. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
{{SEFBox | {{SEFBox | ||
| name=Build System | | name=Build System | ||
| currentState= | | currentState= | ||
− | * [http://www.cmake.org/ CMake | + | * [http://www.cmake.org/ CMake] |
* [http://api.kde.org/cmake/modules.html Custom CMake module documentation] | * [http://api.kde.org/cmake/modules.html Custom CMake module documentation] | ||
| getInvolved= | | getInvolved= | ||
Line 54: | Line 46: | ||
multiple platforms supported by KDE. | multiple platforms supported by KDE. | ||
− | This tool was chosen as the buildsystem for the | + | This tool was chosen as the buildsystem for the KDE SC 4 series, and there |
− | are no plans currently to migrate away from it. | + | are no plans currently to migrate away from it. |
− | + | ||
{{SEFBox | {{SEFBox | ||
Line 74: | Line 65: | ||
| name=Patch review (pre commit) | | name=Patch review (pre commit) | ||
| currentState= | | currentState= | ||
− | * [ | + | |
− | * | + | * [https://projects.kde.org/projects/kdereview KDE Review Module] |
+ | * [[Development/Review_Board|KDE Review Board]] | ||
| people= | | people= | ||
− | |||
| getInvolved= | | getInvolved= | ||
* {{KDEML|kde-core-devel}}: Discuss KDE patch review and tools | * {{KDEML|kde-core-devel}}: Discuss KDE patch review and tools | ||
− | |||
− | |||
}} | }} | ||
In general KDE does not have a formal patch review policy for individual | 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 | patches. Some patches do get reviewed prior to committing to svn by the | ||
− | relevant mailing lists. This is the case for particularly large patches | + | relevant mailing lists or on the Review Board. This is the case for particularly large patches or patches by new developers. |
− | or patches by new developers. | + | |
As an official policy kdereview is used to review new applications and | As an official policy kdereview is used to review new applications and | ||
− | new classes for kdelibs prior to inclusion in KDE trunk. A drawback of | + | new classes for kdelibs prior to inclusion in KDE trunk. See [[Policies/Application_Lifecycle#Stage_2:_Stable|Application Lifecycle]] for some more details. |
− | 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, | + | 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, |
− | eg, | + | |
* All new classes documented [x] | * All new classes documented [x] | ||
Line 108: | Line 95: | ||
| currentState= | | currentState= | ||
* {{KDEML|kde-commits}} mailing list records all commits to KDE svn. | * {{KDEML|kde-commits}} mailing list records all commits to KDE svn. | ||
− | * The [http:// | + | * 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>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>BUG:</tt> feature used to close bugs, and also notifies all bug subscribers of the commit. | ||
Line 141: | Line 128: | ||
| currentState= | | currentState= | ||
* http://techbase.kde.org | * http://techbase.kde.org | ||
− | |||
| getInvolved= | | getInvolved= | ||
* {{KDEML|kde-www}} | * {{KDEML|kde-www}} | ||
Line 172: | Line 158: | ||
* http://userbase.kde.org | * http://userbase.kde.org | ||
* [http://i18n.kde.org/docs/doc-primer/check-docs.html meinproc] is used to generate user documentation. | * [http://i18n.kde.org/docs/doc-primer/check-docs.html meinproc] is used to generate user documentation. | ||
− | * {{KDEML|kde- | + | * {{KDEML|kde-doc-english}} Records all SVN commits with the <tt>GUI</tt> magic word. |
| getInvolved= | | getInvolved= | ||
* http://userbase.kde.org Create tutorials and tips. | * http://userbase.kde.org Create tutorials and tips. | ||
* {{KDEML|kde-doc-english}} Used to coordinate user documentation. | * {{KDEML|kde-doc-english}} Used to coordinate user documentation. | ||
− | * {{KDEML|kde-docbook}} | + | * {{KDEML|kde-docbook}} For technical discussions about docbook. |
}} | }} | ||
Line 228: | Line 214: | ||
| currentState= | | currentState= | ||
* [http://developer.kde.org/~dirk/dashboard/ Continuous build server] reports broken builds on linux. | * [http://developer.kde.org/~dirk/dashboard/ Continuous build server] reports broken builds on linux. | ||
− | * [http:// | + | * [http://my.cdash.org/index.php?project=kdelibs CDash build server] stores results of Nightly builds for KDE modules. |
| getInvolved= | | getInvolved= | ||
* {{KDEML|kde-core-devel}} Find out how to submit test build results. | * {{KDEML|kde-core-devel}} Find out how to submit test build results. | ||
| people= | | people= | ||
* [http://wire.dattitu.de/authors/2-Dirk Dirk Mueller] maintains the dashboard | * [http://wire.dattitu.de/authors/2-Dirk Dirk Mueller] maintains the dashboard | ||
− | * Bill Hoffman is involved with the | + | * Bill Hoffman is involved with the CDash service provided by Kitware. |
* http://www.cdash.org/mailinglist.html | * http://www.cdash.org/mailinglist.html | ||
}} | }} | ||
Line 294: | Line 280: | ||
| getInvolved= | | getInvolved= | ||
* {{KDEML|kde-usability}} | * {{KDEML|kde-usability}} | ||
− | * [[Projects/Usability/HIG KDE Human interaction Guidelines]]. | + | * [[Projects/Usability/HIG|KDE Human interaction Guidelines]]. |
}} | }} | ||
Line 393: | Line 379: | ||
| name=Feature planning | | name=Feature planning | ||
| currentState= | | currentState= | ||
− | * [[Schedules/KDE4/4. | + | * [[Schedules/KDE4/4.6_Feature_Plan]] |
| people= | | people= | ||
[https://mail.kde.org/mailman/listinfo/release-team The KDE release team] | [https://mail.kde.org/mailman/listinfo/release-team The KDE release team] | ||
Line 418: | Line 404: | ||
| currentState= | | currentState= | ||
* The {{KDEML|kde-artists|kde-artists team}} creates offical artwork for KDE. | * The {{KDEML|kde-artists|kde-artists team}} creates offical artwork for KDE. | ||
− | * kde-look.org for non-offical artwork. | + | * [http://kde-look.org kde-look.org] for non-offical artwork. |
| people= | | people= | ||
* [http://pinheiro-kde.blogspot.com/ Nuno Pinheiro] | * [http://pinheiro-kde.blogspot.com/ Nuno Pinheiro] | ||
Line 425: | Line 411: | ||
}} | }} | ||
− | Additional contributed artwork is available on | + | Additional contributed artwork is available on kde-look.org. |
There may be a need to create tutorials on how to create artwork for kde. | There may be a need to create tutorials on how to create artwork for kde. | ||
Line 432: | Line 418: | ||
| name=Translation | | name=Translation | ||
| currentState= | | currentState= | ||
− | * http:// | + | * http://l10n.kde.org/ is used for level of completion of translations in KDE. |
* GNU gettext is used for translation in KDE. | * GNU gettext is used for translation in KDE. | ||
* <tt>.po</tt> files are edited directly in KDE svn to update translations. | * <tt>.po</tt> files are edited directly in KDE svn to update translations. | ||
Line 447: | Line 433: | ||
| name=KDE e.v. - Representative Legal Entity | | name=KDE e.v. - Representative Legal Entity | ||
| currentState= | | currentState= | ||
− | * [http://ev.kde.org KDE e.v] is a registered non-profit organization that represents the KDE Project in legal and financial matters. | + | * [http://ev.kde.org KDE e.v.] is a registered non-profit organization that represents the KDE Project in legal and financial matters. |
− | + | ||
| getInvolved= | | getInvolved= | ||
* [http://ev.kde.org/getinvolved/ KDE e.v. membership] | * [http://ev.kde.org/getinvolved/ KDE e.v. membership] | ||
+ | * [http://jointhegame.kde.org/ Join the Game] | ||
}} | }} | ||
Line 459: | Line 445: | ||
* [[Policies/Licensing_Policy|KDE licencing policy]] allows commercial and non-commercial development and proprietry and non-proprietry development. | * [[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. | * [[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. | ||
− | |||
}} | }} | ||
Line 466: | Line 451: | ||
| currentState= | | currentState= | ||
* [http://ev.kde.org/supporting-members.php Supporters of KDE] contribute sponsorship money to KDE e.v. | * [http://ev.kde.org/supporting-members.php Supporters of KDE] contribute sponsorship money to KDE e.v. | ||
− | * http://ev.kde.org/getinvolved/supporting-members.php | + | | 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 |