:A quick overview of issues with binary compatibility with C++. Keep this in mind while altering the API of kdelibs.

:A quick overview of issues with binary compatibility with C++. Keep this in mind while altering the API of kdelibs.

−

−

;[[/CMake and Source Compatibility|CMake and Source Compatibility]]

−

:Keeping future KDE releases CMake-compatible

;[[/URI & XML Namespaces Policy|URI & XML Namespaces Policy]]

;[[/URI & XML Namespaces Policy|URI & XML Namespaces Policy]]

Revision as of 13:59, 5 September 2009

There are a couple of written and unwritten rules KDE developers usually adhere to. The following documents summarize some of these policies. The list is still incomplete. If you are interested in helping out with formulating the KDE policies or would like to discuss them please use the kde-policies mailing list which was created for this purpose.

Policies for Developers

These policies apply to KDE developers and it is expected that all persons with a KDE SVN account follow these policies. The SVN commit policy is the most important one. Persons working on libraries (kdelibs mostly, but central libraries in other SVN modules fall under this as well) should read the library documentation policy (and the apidox howto as well).

Rules for commits to the KDE SVN repository. The three golden rules (make sure it compiles, follow existing coding style, use descriptive log messages) and 18 more rules to follow to make sure that your SVN commits are the best they can be.

Libraries for (re)use should be completely documented. This policy explains why as well as how to document things, and what style to follow. The apidox howto contains more technical information on writing documentation for libraries.

There are classes and functions in Qt or other places that should be avoided by KDE applications.

Procedures

Whereas policies are normative for individual developers -- that is, they describe how developers must behave -- procedures describe how 'the KDE project' as a whole has chosen to behave. We describe what we will do under certain circumstances and why.