Guidelines for creating a new framework

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

  • Make sure it follows all the active policies
  • 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
  • Ensure the module is in frameworks/ (in the XML), otherwise ask for it to be moved there
  • Adjust kde-build-metadata - in particular, add it to the deps for frameworks/kf5umbrella
  • Get the job set up on and added to the view
  • Ensure it is green
  • Add a new component for it on
  • Add the repository to (by asking the sysadmins)
  • Finally when it's all ready, change the yaml file to say release: true. The release scripts will then pick it up automatically for the next KF release.


The framework-template directory in the kdeexamples repository has a 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

./ KConfig ../../kconfig

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

Content is available under Creative Commons License SA 4.0 unless otherwise noted.