Difference between revisions of "Frameworks/CreationGuidelines"

Jump to: navigation, search
(Guidelines for creating a new framework)
(Guidelines for creating a new framework)
Line 12: Line 12:
 
* Add a new component for it on bugs.kde.org
 
* Add a new component for it on bugs.kde.org
 
* Add the repository to reviewboard.kde.org (by asking the sysadmins)
 
* 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.
+
* 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.
  
 
== Template ==
 
== Template ==

Revision as of 09:13, 4 April 2015

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
  • Ensure the module is in frameworks/ (in the projects.kde.org 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 build.kde.org and added to the http://build.kde.org/view/Frameworks/ view
  • 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)
  • 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.

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.


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