(Created page with "= Guidelines for creating a new framework = If you are creating a new framework, this checklist can help you get it done correctly: * If it is created by splitting code from ...")
 
(Guidelines for creating a new framework)
Line 10: Line 10:
 
* 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)
 +
 +
== 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<syntaxhighlight lang="bash">
 +
./setup.sh KConfig ../../kconfig
 +
</syntaxhighlight>
 +
then go to the newly created "kconfig" directory and start adding source files etc.

Revision as of 22:59, 8 January 2014

Guidelines for creating a new framework

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

  • 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
  • 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)

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.