← Frameworks/CreationGuidelines You do not have permission to edit this page, for the following reason: The action you have requested is limited to users in one of the groups: Users, Administrators, trusted, KDEDevelopers. You can view and copy the source of this page. = 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 [[Frameworks/Policies|active policies]] * The above includes many important things, make sure to read all of it. E.g. it includes the often forgotten [[Frameworks/Frameworks_Localization_Policy#KI18n_installation_code|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 ** Get the job set up on build.kde.org by filing a task towards https://phabricator.kde.org/tag/build.kde.org/ ** Make sure to request it to be added to the relevant view: http://build.kde.org/view/Frameworks%20kf5-qt5/ view ** Ensure it is green * 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 [http://quickgit.kde.org/?p=kdeexamples.git&a=tree&f=framework-template 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. Return to Frameworks/CreationGuidelines. Retrieved from "https://community.kde.org/Frameworks/CreationGuidelines"