Toggle the table of contents

Archive:Development/Software Engineering Framework (zh TW): Difference between revisions

From KDE TechBase

Revision as of 17:36, 2 October 2009

Development/Software_Engineering_Framework

此網頁的目的是總結KDE 專案在軟體工程方面所使用的工具和步驟；換言之，所有程式設計相關的工作。這包括bug修正、審查、測試、文件、需求等等。

KDE 目前使用的工具列出了其使用範圍、已知的替代品、和優缺點。

開發工具

Template:SEFBox (zh TW)

Subversion 1.4 是 KDE 目前使用的原始碼控制管理系統，伺服器位於法蘭克福。另一個唯讀鏡像位於anonsvn.kde.org。

已有考慮移植到一個分散式原始碼控制管理工具，如 GIT。關於這件事的討論詳見 kde-scm-interest郵件列表。很可能是 git 和其他工具一起使用，諸如repo。

Template:SEFBox (zh TW)

CMake 是 KDE 目前使用的構建工具。他是由 kitware inc 開發的自由軟體，可用於 KDE 的多平台支援。

該工具被用於 KDE4 系列的建構系統，目前還沒有替換的計劃。CMake 2.6.2 版就是建構 KDE 4.2 必需的。

Template:SEFBox (zh TW)

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.

審查

Template:SEFBox (zh TW)

通常 KDE 並不對單個補丁(patch)提供正規審查策略。有些補丁在提交到 SVN 之前就在相關的郵件列表審查過了。這個項目是特別針對一個大補丁或是新開發者的補丁。

作為官方政策 kdereview 用於審查進入 KDE trunk 前的新應用程式和 kdelibs 的新類別。該系統的缺點是並非所有審查報告，他們都審查新的內容。它可能是審查使用的檢查清單，例如：

所有新加類別都有提供文件 [x]
正確合理使用私有類別和 d-pointers [x]
通過所有 Krazy 檢查 [ ]
沒有明顯的安全問題 [ ]
設計良好、易維護 [ ]
等等...

這些議題在這裡有所討論，但尚未精煉成 techbase 頁面。

Template:SEFBox (zh TW)

許多專案使用提交過濾器來發送所有提交給相關郵件列表。

Template:SEFBox (zh TW)

KDE 沒有正式的設計審查流程。一些設計審查就是 kdereview 流程的一部分。將來也許要把它正規化或鼓勵有一些設計文件。

文件

Template:SEFBox (zh TW)

techbase.kde.org 是個 MediaWiki 網站，用於收集技術任務如教學、時間表和專案資訊。wiki.kde.org 是個 tiki-wiki 網站，有類似功能。兩個都還在使用，將來也許會合二為一。

Template:SEFBox (zh TW)

KDE API 文件是每日生成並放在 http://api.kde.org 。它也可以使用 IDE 來生成相同的本地文件。

可以從 KDE 原始碼創建 man pages 和qthelp 文件。

Template:SEFBox (zh TW)

使用者文件是從模塊 doc/ 目錄產生的，在 http://docs.kde.org 上也有。

meinproc 是一個 KDE 工具（Stephen Kulow 所寫，它使用libxslt 轉變 docbook 成（bzip壓縮）html。在運行時 kio_help 打開 bzip 壓縮過的 html 並在 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.

測試和品質

Template:SEFBox (zh TW)

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.

Template:SEFBox (zh TW)

Additional checks are always welcome for adding to Krazy. See http://websvn.kde.org/trunk/quality/.

Template:SEFBox (zh TW)

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

Template:SEFBox (zh TW)

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

Template:SEFBox (zh TW)

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

Template:SEFBox (zh TW)

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

Template:SEFBox (zh TW)

市場和期望

Template:SEFBox (zh TW)

發布

Template:SEFBox (zh TW)

目前使用 techbase 討論功能計劃，但也許還有更好的替代品。

Template:SEFBox (zh TW)

佈景主題和翻譯

Template:SEFBox (zh TW)

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.

Template:SEFBox (zh TW)

法律與支援

Template:SEFBox (zh TW)

Retrieved from "https://techbase.kde.org/index.php?title=Archive:Development/Software_Engineering_Framework_(zh_TW)&oldid=45172"

@@ Line 71: / Line 71: @@
 通常 KDE 並不對單個補丁(patch)提供正規審查策略。有些補丁在提交到 SVN 之前就在相關的郵件列表審查過了。這個項目是特別針對一個大補丁或是新開發者的補丁。
-As an official policy kdereview is used to review new applications and
+作為官方政策 kdereview 用於審查進入 KDE trunk 前的新應用程式和 kdelibs 的新類別。該系統的缺點是並非所有審查報告，他們都審查新的內容。它可能是審查使用的檢查清單，例如：
-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,
-* All new classes documented [x]
+* 所有新加類別都有提供文件 [x]
-* Private classes and d-pointers used where appropriate [x]
+* 正確合理使用私有類別和 d-pointers  [x]
-* Passes all krazy checks [ ]
+* 通過所有 Krazy 檢查 [ ]
-* 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.
+這些議題在[http://thread.gmane.org/gmane.comp.kde.devel.core/54213 這裡]有所討論，但尚未精煉成 techbase 頁面。
 {{SEFBox (zh TW)
 | name=提交審查(提交後)
 | currentState=
-* {{KDEML|kde-commits}} mailing list records all commits to KDE svn.
+* {{KDEML|kde-commits}} 郵件列表記錄所有 KDE svn 的提交。
-* The [http://commit-filter.org commit filter] is used to filter relevant commits based on path of the commit.
+* [http://commit-filter.org 提交過濾器] 用於過濾那些基於提交補丁的相關提交。
-* SVN <tt>CCMAIL:</tt> feature used to notify relevant mailing lists or individuals of specific commits.
+* SVN <tt>CCMAIL:</tt> 用於通知相關的郵件列表或特別的提交。
-* SVN <tt>BUG:</tt> feature used to close bugs, and also notifies all bug subscribers of the commit.
+* SVN <tt>BUG:</tt> 用來關閉 bug，並通知所有 bug 提交的訂閱者。
-* 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.
+* SVN <tt>CCBUG:</tt> 用來通知關閉更新的 bug。移植時常用修復分支之間。還通知 bug 提交的訂閱者。
 | getInvolved=
 * {{KDEML|kde-commits}}
@@ Line 115: / Line 111: @@
 }}
-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.
+KDE 沒有正式的設計審查流程。一些設計審查就是 kdereview 流程的一部分。將來也許要把它正規化或鼓勵有一些設計文件。
 == 文件==
@@ Line 132: / Line 128: @@
 }}
-techbase.kde.org 是個[http://www.mediawiki.org MediaWiki]網站 ，用於收集技術任務如教學、時間表和專案資訊。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.
+techbase.kde.org 是個 [http://www.mediawiki.org MediaWiki] 網站 ，用於收集技術任務如教學、時間表和專案資訊。wiki.kde.org 是個 tiki-wiki 網站，有類似功能。兩個都還在使用，將來也許會合二為一。
 {{SEFBox (zh TW)
@@ Line 156: / Line 151: @@
 | currentState=
 * 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] 用於產生使用者文件。
-* {{KDEML|kde-docbook}} Records all SVN commits with the <tt>GUI</tt> magic word.
+* {{KDEML|kde-docbook}} 記錄所有<tt>GUI</tt> magic word 的 SVN 提交。
 | getInvolved=
-* http://userbase.kde.org Create tutorials and tips.
+* http://userbase.kde.org 創建教學和提示。
-* {{KDEML|kde-doc-english}} Used to coordinate user documentation.
+* {{KDEML|kde-doc-english}} 用於協調使用者文件。
-* {{KDEML|kde-docbook}} Help update documentation after GUI changes.
+* {{KDEML|kde-docbook}} 協助更新 GUI 變更後的文件。
 }}
-User documentation is generated from module doc/ folders and hosted on http://docs.kde.org.
+使用者文件是從模塊 doc/ 目錄產生的，在 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.
+meinproc 是一個 KDE 工具（Stephen Kulow 所寫，它使用libxslt 轉變 docbook 成（bzip壓縮）html。在運行時 kio_help 打開 bzip 壓縮過的 html 並在 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.
@@ Line 198: / Line 193: @@
 {{SEFBox (zh TW)
-| name=Static code analysis
+| name=靜態程式碼分析
 | currentState=
 * [http://www.englishbreakfastnetwork.org/krazy/ Krazy] hosted at EnglishBreakfastNetwork (EBN).
@@ Line 247: / Line 242: @@
 {{SEFBox (zh TW)
-| name=Quality testing
+| name=品量測試
 | currentState=
 * The early adopter/user community
@@ Line 262: / Line 257: @@
 {{SEFBox (zh TW)
-| name=Profiling and Optimizations
+| name=分析和最佳化
 | currentState=
 * {{KDEML|kde-optimize}} mailing list coordinates optimizations in KDE.
@@ Line 308: / Line 303: @@
 | name=需求收集
 | currentState=
-* Requirements come from user feedback on http://bugs.kde.org and from commercial interests.
+* 需求收集自使用者的反饋在 http://bugs.kde.org 和商業參與。
 * Developers may do some research into requirements for applications based on User Research Profiles.
 | getInvolved=
-* http://bugs.kde.org Fill new wishlist items.
+* http://bugs.kde.org 加入新的願望列表項目。
-* {{KDEML|kde-core-devel}} Discuss new ways for kde to gather requirements.
+* {{KDEML|kde-core-devel}} 討論 kde 獲取需求的新方法。
 }}
@@ Line 319: / Line 314: @@
 | name=推廣
 | currentState=
-* The {{KDEML|kde-promo|KDE marketing team}} manage marketing and promotion from official kde sources.
+* {{KDEML|kde-promo|KDE 行銷團隊}}管理 KDE 官方來源的行銷和推廣。
-* http://dot.kde.org is the community forum around promotional announcements.
+* http://dot.kde.org 是一個關於推廣公告的社群論壇。
-* http://www.kde.org/announcements is the official source of promotional announcements regarding KDE.
+* http://www.kde.org/announcements 是 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.
@@ Line 331: / Line 326: @@
 | getInvolved=
 * {{KDEML|kde-promo}}
-* [http://dot.kde.org/addPostingForm Submit dot articles]
+* [http://dot.kde.org/addPostingForm 提交 dot 文章]
 }}
@@ Line 363: / Line 358: @@
 開發人員和使用者間的溝通：
-* [http://planetkde.org 部落格] to some extent (mainly early adopting users).
+* [http://planetkde.org 部落格]在一定程度上（主要是早期採用的使用者）。
-* [http://forum.kde.org 論壇] to some extent where the developer chooses to.
+* [http://forum.kde.org 論壇]在一定程度上影響開發者的選擇。
 * [http://dot.kde.org 新聞公告]
@@ Line 375: / Line 370: @@
 * [http://c133.org/blog/ Chris Lee]，管理 planetkde.org
 | getInvolved=
-* Add your blog to planet kde if you contribute to KDE in some way, including development, testing, advocacy, translation, documentation etc.
+* 如果你在某些方面貢獻 KDE ，加入您的部落格到 planet kde。包括開發、測試、宣傳、翻譯、文件等。
 }}
@@ Line 439: / Line 434: @@
 | currentState=
 * http://i18n.kde.org/ is used for level of completion of translations in KDE.
-* GNU gettext is used for translation in KDE.
+* GNU gettext 在 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/.
+* kde4 為基礎的翻譯程式（[http://userbase.kde.org/Lokalize Lokalize]）在 kdesdk/。
-* Krazy includes sanity checks/plurals checking for translation.
+* Krazy 包括翻譯的完整性檢查、複數檢查。
 | 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.
@@ Line 453: / Line 448: @@
 | name=KDE e.v. - 代表法律實體
 | 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] 是一個註冊非營利機構，在法律和財務上代表 KDE 專案。
 | altTools= 無
 | getInvolved=
@@ Line 460: / Line 455: @@
 {{SEFBox (zh TW)
-| name=Resolving licencing issues.
+| name=解決授權問題。
 | 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.
@@ Line 469: / Line 464: @@
 {{SEFBox (zh TW)
-| name=Sponsorship and Patronship
+| name=贊助與合作
 | 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 KDE 的支持者]贊助資金給 KDE e.v.
 * http://ev.kde.org/getinvolved/supporting-members.php
 | altTools= 無
 }}