Difference between revisions of "Krita/Hacking"

Jump to: navigation, search
(Getting in touch)
(Separate sections for "patch review" and "getting in touch", and add #krita)
Line 14: Line 14:
  
 
== Building Krita ==  
 
== Building Krita ==  
To get started, all you need to do is get a copy of Krita and build it! This is not all that much much different from building something off GitHub... except that Krita is a very large compared to most software.  There are [https://community.kde.org/Krita#Build_instructions instructions on this wiki] to build on various platforms.
+
To get started, all you need to do is get a copy of Krita and build it! This is not all that much much different from building something off GitHub... except that Krita is a very large compared to most software.  There are [https://community.kde.org/Krita#Build_instructions instructions on this wiki] to get you going on various platforms, but of course Linux is easiest.
  
 
== KDE Identity ==
 
== KDE Identity ==
Line 23: Line 23:
 
https://identity.kde.org/
 
https://identity.kde.org/
  
== Getting in touch ==
+
== Contributing patches ==
Patch review and issue tracking happens on Phabricator. Just search for Krita under Projects! Use your KDE Identity for the LDAP login field to log in. If you are used to Github, the transition to Phabricator is not difficult, but will require changing a few habits.  The Techbase Wiki hosts an [https://techbase.kde.org/Development/Phabricator introduction to Phabricator]. You can begin your first patch submission by clicking "Differential."
+
Patch review and issue tracking happens on [https://phabricator.kde.org/  Phabricator]. To log in, enter your KDE Identity in the LDAP login field. You can join the [https://phabricator.kde.org/project/profile/8/ Krita: Next] and [https://phabricator.kde.org/project/profile/7/ Krita: stable] projects to receive alerts and track patch reviews, and you can install the [https://phabricator.kde.org/dashboard/view/7/ Krita dashboard] to get feeds when you log in.
  
https://phabricator.kde.org/
+
If you are used to Github, the transition to Phabricator is not difficult, but it is slightly different.  The Techbase Wiki hosts an [https://techbase.kde.org/Development/Phabricator introduction to Phabricator] going over the basics.
  
 +
You can begin your first patch submission by clicking "Differential." Be sure to set the reviewer, or nobody will be alerted to your patch! For feature requests and most patches, choose <tt>Krita: next</tt> as the reviewer in the web interface.  If you use the Arcanist tool, add the hashtag #krita in the reviewers field.  For bug fixes, choose <tt>Krita: stable</tt>, the hashtag is <tt>#krita:_stable</t> with an underscore.  (''note: ask boud to add a nicer one'')
  
Other places to talk with devs are IRC, the mailing list, and the forums. Wolthera put together a nice guide here.
+
== Getting in touch ==
 +
Other places to talk with devs are IRC, where a majority of talk happens, the mailing list, where formal announcements and meeting minutes are written, and the forums, generally more focused on responding to user posts. Wolthera put together a nice guide here.
 
https://forum.kde.org/viewtopic.php?f=288&t=125955
 
https://forum.kde.org/viewtopic.php?f=288&t=125955
  
Line 44: Line 46:
 
== Calligra and Krita ==
 
== Calligra and Krita ==
 
In October 2015, the Krita project separated from the rest of the Calligra office suite.  The new repository still clearly contains this history. Most source code files will have one of two prefixes. "Ko" stands for KOffice, the original name of Calligra office suite.  These files mostly comprise basic, lower-level libraries.  "Kis" stands for KImageShop, the original name of Krita. These files are where most of the painting-specific functionality is maintained.
 
In October 2015, the Krita project separated from the rest of the Calligra office suite.  The new repository still clearly contains this history. Most source code files will have one of two prefixes. "Ko" stands for KOffice, the original name of Calligra office suite.  These files mostly comprise basic, lower-level libraries.  "Kis" stands for KImageShop, the original name of Krita. These files are where most of the painting-specific functionality is maintained.
 +
 +
Krita 2.9 stable is built from the Calligra repo.  Krita 3.x is built from the Krita repo.
  
 
== Style guidelines ==
 
== Style guidelines ==

Revision as of 15:58, 10 December 2015

Getting started with KDE Software

Krita is a great place to start even if you are brand new to KDE development. We'd love to have you join!

KDE has undergone big changes since a major 2014 reorganization. As a result, working with KDE software has never been easier. Unfortunately, since the changes were so widespread, the documentation has not caught up at all. If you are embarking on this journey, it would be very generous to share your discoveries with others and update pages. (=

The KDE Techbase Wiki has instructions for new developers. On top of basic tools like C++, git, and general notions such as building software libraries, some special tools that are particular to Krita are Qt, CMake, and KDE Frameworks. It can be very helpful to get started by finding some of the articles discussing these tools and reading up. Here are some of the more useful pages to get you started:

Building Krita

To get started, all you need to do is get a copy of Krita and build it! This is not all that much much different from building something off GitHub... except that Krita is a very large compared to most software. There are instructions on this wiki to get you going on various platforms, but of course Linux is easiest.

KDE Identity

If you intend to be a regular contributor to Krita, the first thing you will want to do is register for a KDE Identity account. This serves as your login for many places in KDE websites. (Including this wiki! Select the OpenID / Identity Login option and use your KDE Identity account.)

This is the account that is used for repository commit access as well.

https://identity.kde.org/

Contributing patches

Patch review and issue tracking happens on Phabricator. To log in, enter your KDE Identity in the LDAP login field. You can join the Krita: Next and Krita: stable projects to receive alerts and track patch reviews, and you can install the Krita dashboard to get feeds when you log in.

If you are used to Github, the transition to Phabricator is not difficult, but it is slightly different. The Techbase Wiki hosts an introduction to Phabricator going over the basics.

You can begin your first patch submission by clicking "Differential." Be sure to set the reviewer, or nobody will be alerted to your patch! For feature requests and most patches, choose Krita: next as the reviewer in the web interface. If you use the Arcanist tool, add the hashtag #krita in the reviewers field. For bug fixes, choose Krita: stable, the hashtag is #krita:_stable</t> with an underscore. (note: ask boud to add a nicer one)

Getting in touch

Other places to talk with devs are IRC, where a majority of talk happens, the mailing list, where formal announcements and meeting minutes are written, and the forums, generally more focused on responding to user posts. Wolthera put together a nice guide here. https://forum.kde.org/viewtopic.php?f=288&t=125955

Debugging

When you run a debug build of Krita, you may be surprised how little debug output you see. This is because most of Krita's debugging information is turned off by default. The debug statements are grouped into categories such as dbgUI, dbgKrita and so on. The output categories are controlled by an environment variable QT_LOGGING_RULES.

The list of Krita's debug categories is contained in kis_debug.h and main.cc, and the rules for the environment variable are described in the Qt reference for QLoggingCategory.

As an example, to enable most of Krita's debug output, you can run the following:

export QT_LOGGING_RULES="krita*=true"; krita

Using the rule *=true will produce a firehose, if you want it.

Calligra and Krita

In October 2015, the Krita project separated from the rest of the Calligra office suite. The new repository still clearly contains this history. Most source code files will have one of two prefixes. "Ko" stands for KOffice, the original name of Calligra office suite. These files mostly comprise basic, lower-level libraries. "Kis" stands for KImageShop, the original name of Krita. These files are where most of the painting-specific functionality is maintained.

Krita 2.9 stable is built from the Calligra repo. Krita 3.x is built from the Krita repo.

Style guidelines

See HACKING in the codebase.

Development Philosophy

Krita is nearly ten years old, consists of around 1.1 million lines of code, and has had many individual contributors throughout the years. If you run into something in the code that doesn't make sense to you, it may very well not make sense to anyone. Developing a codebase this large is an art form, you should feel confident in making risky changes even if you're not sure they'll work, you can always go back with git checkout -- * if you mess it up!


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