Frameworks/CreationGuidelines

< Frameworks
Revision as of 06:44, 10 April 2016 by IvanC (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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
  • The above includes many important things, make sure to read all of it. E.g. it includes the often forgotten rule for installing translations
  • 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 doesn't depend on deprecated or "portingAid" frameworks like kdelibs4support
  • Ensure the module is in frameworks/ (in the projects.kde.org XML), otherwise ask for it to be moved there
  • Adjust kde:kde-build-metadata - in particular, add it to the deps for frameworks/kf5umbrella
  • Get the CI jobs set up
  • Add a new product for it on bugs.kde.org, which must be called frameworks-<name>
  • Add the repository to reviewboard.kde.org (by filing a sysadmin ticket)
  • Create a README.md file
  • 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.


This page was last modified on 10 April 2016, at 06:44. Content is available under Creative Commons License SA 4.0 unless otherwise noted.