Archive:Development/Software Engineering Framework (zh CN)

Development/Software_Engineering_Framework

此网页的目的是总结KDE项目在软件工程方面所使用的工具和程序；覆盖所有编码工作。这包括错误修正，审查，测试，文档，需求等等。

目前所使用的KDE的工具集列出了其使用范围，已知的替代品，和优点/缺点。

开发工具

代码控制

Current State	People
Subversion 1.4	The kde sysadmin team: Dirk Müller David Faure
Get Involved	Alternative Tools
kde-scm-interest	git, repo bazaar mercurial Gitorious

Subversion 1.4是目前用于KDE的源代码管理系统，服务器位于法兰克福。另一个只读镜像位于anonsvn.kde.org。

There is interest in migrating to a distributed source control management tool, such as GIT. Discussion of this is taking place on the kde-scm-interest mailing list. It is likely git will be used along with a tool such as repo.

联编系统

Current State	People
CMake 2.6.0 定制CMake模块文档	Alexander Neundorf
Get Involved	Alternative Tools
kde-buildsystem	n/a

CMake是目前KDE使用的构建工具。他是由kitware inc开发的自由软件，可用于多个KDE平台。

该工具被用于KDE4系列的联编，目前还没有替换的计划。CMake 2.6.2版本就是用来联编KDE 4.2的。

搜寻

Current State	People
http://lxr.kde.org	The kde sysadmin team: Dirk Müller David Faure
Get Involved	Alternative Tools
n/a	n/a

LXR为KDE中的类和方法作出索引。他可以用来方便的找出适合使用一个类，并且找到他在整个程序里是如何被使用的。通常在重构是很有用。

审阅

审阅补丁(递交前)

Current State	People
Review-board用于Plasma项目。 trunk/kdereview	David Solbach and the kde sysadmin team maintain the Plasma review-board installation.
Get Involved	Alternative Tools
kde-core-devel: Discuss KDE patch review and tools	Launchpad.net offers merge review/approval pre-merge [1] [2] [3]

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. 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. 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,

新加内容都有文档记录 [x]
私有类和d-指针正确合理使用 [x]
通过测试 [ ]
没有明显安全顾虑 [ ]
设计良好、易维护 [ ]
等等

这些议题在这里有所讨论，但目前还没有一个定稿。所以没有提现在这里。

递交审阅(递交后)

Current State	People
kde-commits mailing list records all commits to KDE svn. The commit filter is used to filter relevant commits based on path of the commit. SVN `CCMAIL:` feature used to notify relevant mailing lists or individuals of specific commits. SVN `BUG:` feature used to close bugs, and also notifies all bug subscribers of the commit. SVN `CCBUG:` feature used to notify closed bugs of updates. Commonly used when porting fixes between branches. Also notifies all bug subscribers of the commit.	Unknown
Get Involved	Alternative Tools
kde-commits	未知

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 mailing lists project wikis face-to-face/BOF sessions and sprints kdereview	Unknown
Get Involved	Alternative Tools
kde-core-devel is used to announce new additions to kdereview.	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
http://techbase.kde.org http://wiki.kde.org http://wiki.koffice.org	Danimo is the MediaWiki admin for techbase.kde.org.
Get Involved	Alternative Tools
kde-www	n/a

techbase.kde.org is a MediaWiki powered site used for collaborating on technical tasks such as tutorials, schedules, and project information. wiki.kde.org is a tiki-wiki site with the same function. Both are actively used. It might make sense to merge the two sites.

API文档

Current State	People
Doxygen is used to generate api documentation from documentation strings in code.	Allen Winter administers api.kde.org.
Get Involved	Alternative Tools
APIDOX tutorials Make KDE API docs better.	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 man pages and qthelp documentation from kde sources.

用户手册

Current State	People
http://userbase.kde.org meinproc is used to generate user documentation. kde-docbook Records all SVN commits with the `GUI` magic word.	Unknown
Get Involved	Alternative Tools
http://userbase.kde.org 创建教程和提示. kde-doc-english 用于协调用户文档。 kde-docbook 用于更新图形界面变更后的文档.	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
Bugzilla 3.0.x. KBugBuster	Matt Rogers and the KDE sysadmin team maintain the KDE bugzilla installation.
Get Involved	Alternative Tools
kde-core-devel Discuss alternative bug trackers for KDE. kde-bugs-dist Records all updates on bugs.kde.org. kdelibs-bugs Records all updates to kdelibs bugs. konq-bugs Records all updates to konqueror bugs. kdevelop-bugs Records all updates to kdevelop bugs. amarok-bugs-dist Records all updates to amarok bugs.	https://bugs.launchpad.net, Leonev trac Redmine - 类似"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.

静态代码检查

Current State	People
Krazy hosted at EnglishBreakfastNetwork (EBN). Coverity is used to find possible sources of defects and suggested optimizations. Results are displayed per module as part of Dirks Dashboard builds.	Adriaan de Groot Allen Winter
Get Involved	Alternative Tools
	n/a

欢迎添加更多Krazy检查。详见http://websvn.kde.org/trunk/quality/.

联编测试

Current State	People
Continuous build server reports broken builds on linux. CDash build server stores results of non-linux builds for kdelibs.	Dirk Mueller maintains the dashboard Bill Hoffman is involved with the kitware CDash service. http://www.cdash.org/mailinglist.html
Get Involved	Alternative Tools
kde-core-devel Find out how to submit test build results.	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:

微软视窗
苹果OS
FreeBSD 6 (gcc)
FreeBSD 7 (gcc)
Solaris (S10, S11)；SPARC和AMD64上

单元测试

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
Techbase单元测试教程	n/a

It may be possible run run these tests automatically possibly on EBN or on Dirks dashboard.

质量测试

Current State	People
The early adopter/user community SQO-OSS	Adriaan de Groot Paul Adams
Get Involved	Alternative Tools
	n/a

It may be possible to obtain metrics such as bugs per kloc, defect injection rate etc.

Profiling and Optimizations

Current State	People
kde-optimize mailing list coordinates optimizations in KDE. Krazy and Coverity tools also include some optimization checks. KDE macros for optimization of common algorithms.	Unknown
Get Involved	Alternative Tools
kde-optimize Coverity report for KDE libs.	n/a

Tutorials may be provided in the future to help developers optimize their code.

Accessibility and Usability

Current State	People
http://usability.kde.org/ http://openusability.org/projects.php Season of usability	Celeste Lyn Paul Ellen Reitmayr
Get Involved	Alternative Tools
kde-usability Projects/Usability/HIG KDE人机交互指南.	n/a

研究

Current State	People
http://research.kde.org SQO-OSS http://nepomuk.kde.org/ Semantic desktop project funded by the EU.	Adriaan de Groot Sebastian Trueg leads the kde-nepomuk project.
Get Involved	Alternative Tools
Nepomuk KDE 邮件列表	n/a

市场和开拓期望

需求收集

Current State	People
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.	Unknown
Get Involved	Alternative Tools
http://bugs.kde.org Fill new wishlist items. kde-core-devel Discuss new ways for kde to gather requirements.	n/a

Promotion

Current State	People
The 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 kde-www mailing list The 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.	Wade Olsen Troy Unrau Jos Poortvliet
Get Involved	Alternative Tools
kde-promo Submit dot articles	n/a

社区管理

Current State	People
The Community Working Group helps with community advice when needed 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.	Anne Willson Juan Carlos Torres Lydia Pintscher Martin Fitzpatrick Tom Albers
Get Involved	Alternative Tools
给[email protected]发邮件	n/a

沟通管理

Current State	People
Developers communicate with each other through mailing lists IRC Blogs Conferences Developers communicate with users though Blogs to some extent (mainly early adopting users). Forums to some extent where the developer chooses to. News announcements Users communicate with each other and developers through Forums kde mailing list #kde irc channel.	Chris Lee administers planetkde.org
Get Involved	Alternative Tools
Add your blog to planet kde if you contribute to KDE in some way, including development, testing, advocacy, translation, documentation etc.	n/a

发布

发布计划

Current State	People
Maintained at Schedules.	Cyrill Berger - KOffice release coordinator. Allen Winter - KDEPIM release coordinator.
Get Involved	Alternative Tools
release-team	n/a

功能计划

Current State	People
Schedules/KDE4/4.1_Feature_Plan Schedules/KDE4/4.2_Feature_Plan	The KDE release team
Get Involved	Alternative Tools
kde-core-devel - 讨论KDE趋势和发展计划。	Launchpad.net offers a blueprints system. Scrum in Open Source Projects

Currently techbase is used for feature planning but there may be better alternatives.

Downstream packagers and contributions

Current State	People
Many distributions package KDE3 & KDE4.	Unknown
Get Involved	Alternative Tools
kde-packagers - Private mailing list for packagers. Includes information relating to security releases.	n/a

主题和翻译

美工

Current State	People
The kde-artists team 创建KDE官方作品。 kde-look.org for non-offical artwork.	Nuno Pinheiro
Get Involved	Alternative Tools
kde-artists	n/a

Additional contributed artwork is available on http://kde-look.org.

There may be a need to create tutorials on how to create artwork for kde.

翻译

Current State	People
http://i18n.kde.org/ is used for level of completion of translations in KDE. GNU gettext is used for translation in KDE. `.po` files are edited directly in KDE svn to update translations. A kde4 based translation client (Lokalize) is being developed in kdesdk/. Krazy includes sanity checks/plurals checking for translation.	Unknown
Get Involved	Alternative Tools
kde-i18n-doc	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.

法律与支持

KDE e.v. - Representative Legal Entity

Current State	People
KDE e.v is a registered non-profit organization that represents the KDE Project in legal and financial matters.	Unknown
Get Involved	Alternative Tools
KDE e.v. membership	不祥

许可证

Current State	People
A 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. KDE licencing policy allows commercial and non-commercial development and proprietry and non-proprietry development. 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.	Unknown
Get Involved	Alternative Tools
n/a	N/A

赞助与合作

Current State	People
Supporters of KDE contribute sponsorship money to KDE e.v. http://ev.kde.org/getinvolved/supporting-members.php	Unknown
Get Involved	Alternative Tools
n/a	N/A