Revision as of 22:11, 11 February 2014

Guidelines for creating a new framework

If you are creating a new framework, this checklist can help you get it done correctly:

ensure it follows http://community.kde.org/Frameworks/Policies (which includes buildsystem etc.)
If it is created by splitting code from an existing repository, the new repository should be created by using a script to create a graft point;
Run astyle-kdelibs;
Make sure it follows all the active policies
Adjust kde-build-metadata - in particular, add it to the deps for frameworks/kf5umbrella
Get the job set up on build.kde.org
Ensure it is green
Add a new component for it on bugs.kde.org
Add the repository to reviewboard.kde.org (by asking the sysadmins)
Add the module to the list in repo kde:sysadmin/release-tools, branch frameworks/5.0, file modules.git, or ask dfaure to add it.

Template

The framework-template directory in the kdeexamples repository has a setup.sh script that generates a helpful skeleton framework that is a good starting point for creating a framework. For example, if you were creating the KConfig framework, you might run

./setup.sh KConfig ../../kconfig

then go to the newly created "kconfig" directory and start adding source files etc.

@@ Line 6: / Line 6: @@
 * Run astyle-kdelibs;
 * Make sure it follows all the [[Frameworks/Policies|active policies]]
-* Adjust kde-build-metadata
+* Adjust kde-build-metadata - in particular, add it to the deps for frameworks/kf5umbrella
 * Get the job set up on build.kde.org
 * Ensure it is green
 * Add a new component for it on bugs.kde.org
 * Add the repository to reviewboard.kde.org (by asking the sysadmins)
+* Add the module to the list in repo kde:sysadmin/release-tools, branch frameworks/5.0, file modules.git, or ask dfaure to add it.
 == Template ==