Difference between revisions of "Projects/PIM/KMail Junior Jobs"

< Projects‎ | PIM
Jump to: navigation, search
m (Bug 71945: Refresh IMAP cache even enabled when action can't be used)
(removing a todo that has allready been implemented (since kmail 4.9))
 
(43 intermediate revisions by 9 users not shown)
Line 1: Line 1:
== KMail Junior Jobs ==
+
== KMail Junior Jobs ==
  
On this page, you'll find small coding jobs for a beginner to work on.
+
On this page, you'll find small coding jobs for a beginner to work on. All these problems are relatively easy, some of them might even be one-liners. Of course, it is always a good idea to find your own thing to fix, the best motivation is scratching your own itch.  
All these problems are relatively easy, some of them might even be one-liners.
+
Of course, it is always a good idea to find your own thing to fix, the best motivation is scratching your own itch.
+
  
These tasks are intended for beginners with little or no experience programming with KDE. For those beginners, the biggest challenges are not actually the coding problems, but setting the development environment up, finding the correct place of code where the bug happens (in the jungle of all those source files) and interacting with the community, with the final step being sending the patch.
+
These tasks are intended for beginners with little or no experience programming with KDE. For those beginners, the biggest challenges are not actually the coding problems, but setting the development environment up, finding the correct place of code where the bug happens (in the jungle of all those source files) and interacting with the community, with the final step being sending the patch.  
  
The knowledge prerequisite for those jobs are not that big. You should be familiar in C++, and knowing Qt a bit would help. Knowing kdelibs or KMail internals is not required, that can usually be picked up during coding.
+
The knowledge prerequisite for those jobs are not that big. You should be familiar in C++, and knowing Qt a bit would help. Knowing kdelibs or KMail internals is not required, that can usually be picked up during coding.  
  
For more general information, visit the following places:
+
For more general information, visit the following places:  
* [[Welcome_to_KDE_TechBase|KDE Techbase]]: Contains a lot of information about developing KDE, in particular a section on how to build KDE from source
+
* [http://websvn.kde.org/*checkout*/trunk/KDE/kdepim/kmail/HACKING KMail's HACKING file]: Some KMail specific information.
+
  
The steps for your first coding contribution are roughly like this:
+
*[[Welcome to KDE TechBase|KDE Techbase]]: Contains a lot of information about developing KDE, in particular a section on how to build KDE from source
 +
*[http://websvn.kde.org/*checkout*/trunk/KDE/kdepim/kmail/HACKING KMail's HACKING file]: Some KMail specific information.
  
#[[Getting_Started/Build/KDE4|Build KDE trunk from sources]], including KDEPIM
+
The steps for your first coding contribution are roughly like this:
#Set up your development environment, i.e. your editor or [[Getting_Started/Set_up_KDE_4_for_development#KDevelop|IDE]]
+
#Pick something to work on, like some of the things suggested below
+
#Start coding and fix the problem!
+
#[[Contribute/Send_Patches|Send in a patch]] (We prefer reviewboard)
+
  
Should you need help, feel free to ask us in the #kontact IRC channel, or mail
+
#[[Getting Started/Build/|Build KDE trunk from sources]], including KDEPIM
either [mailto:mcguire@kde.org Thomas McGuire] (the KMail maintainer) or the [mailto:kde-pim@kde.org kde-pim mailing list].
+
#Set up your development environment, i.e. your editor or [[Getting_Started/Using_an_IDE_with_KDE4|IDE]]
 +
#Pick something to work on, like some of the things suggested below
 +
#Start coding and fix the problem!
 +
#[[Contribute/Send Patches|Send in a patch]] (We prefer reviewboard)
  
If you find some information missing, feel free to add it to this page after you learn it.
+
Should you need help, feel free to ask us in the #kontact IRC channel, or mail either [mailto:mcguire@kde.org Thomas McGuire] (the KMail maintainer) or the [mailto:kde-pim@kde.org kde-pim mailing list].
 +
 
 +
Use the [http://commitfilter.kde.org KDE commitfilter] to subscribe to kdepim and kdepimlibs commits, you will learn a lot from other's commits.
 +
 
 +
If you find some information missing, feel free to add it to this page after you learn it.  
  
 
Below follows a list of junior jobs. It always includes a rough location where in the KMail sources to start.
 
Below follows a list of junior jobs. It always includes a rough location where in the KMail sources to start.
 
=== The default column sizes of the message structure viewer are too small ===
 
  
'''Starting point:''' kmmimeparttree.cpp
+
{{Warning|At this point, '''KMail 1 is completely frozen'''. KMail 1 is the version that is shipped with KDE 4.4.x and earlier versions.
  
'''Difficulty:''' Easy
+
Right now, we are working on KMail 2. KMail 2 is the KMail that is based on Akonadi.
  
'''Description:''' When starting KMail for the first time (i.e. empty kmailrc configuration file), the column sizes for the message structure viewer are not good. The name column is too small, although it should be the largest. KMail should provide good default column sizes for the default window size.
+
Only bugfixes for KMail 1 are still allowed, but no new features or any refactoring.
  
 +
A good way to contribute would be to help with KMail 2, see first entry below.
 +
}}
  
 +
=== Help making KMail 2 ready ===
  
=== Move aggregation, theme and sorting options to the menubar ===
+
'''Difficulty:''' Easy to hard, depends on what you work on
  
'''NOTE: I think Vincent is working on this, so don't take this for now'''
+
'''Description:''' KMail is currently being ported to [http://api.kde.org/kdesupport-api/kdesupport-apidocs/akonadi/html/ Akonadi] and [http://api.kde.org/4.x-api/kdepimlibs-apidocs/kmime/html/index.html KMime]. This work currently takes place in SVN trunk. Once KMail is fully ported, it will be released as KMail 2, probably together with KDE 4.5.
  
'''Starting point:''' kmmainwidget.cpp, messagelistview.cpp/core/widgetbase.cpp, configuredialog.cpp, kmmainwin.cpp/kmail_part.rc
+
That porting is a huge task, comparable to the KDE3 to KDE4 port of KMail (if not even more work). Therefore, any help with porting is greatly appreciated. There are still many unported places in the code which are commented out, or places with defects, or missing features. You'll know what I mean with this when you start KMail, you'll immediately notice those things. This is where you can help: Many of those are easy to fix and quite suitable for newcomers. (Side note: the current KMail maintainer started by helping in the KDE3 to KDE4 port, having no experience with KMail code before. I think the Akonadi port is a comparable effort, with quite some low-hanging fruit you can start on.)
  
'''Difficulty:''' Medium
+
We are tracking bugs that are the result of the Akonadi port of KMail with the '''akonadi-ports-regression''' keyword. This would be a great place to start: Have a look at the bugs tagged with that keyword and help fixing them. Some of those bugs are huge and difficult tasks, while others are easier. You should probably try starting with the ones that have low priority, those are generally easier.
 +
You'll find the bug list with [https://bugs.kde.org/buglist.cgi?keywords=akonadi-ports-regression&resolution=--- this bugzilla query].
  
'''Description:''' Currently, there are 3 little comboboxes next to the quick search dialog, that control the theme, aggregation and sort order. Experience has shown that people don't find it there. Your task is to clean this up a bit. Move the 3 little comboboxes to the menubar, as submenues of the ''View'' menu. Also, make those submenus available when right-clicking a header of the message list. Also, it would be nice to add settings to the configure dialog to change the default theme, aggregation and sort order.
+
=== [http://bugs.kde.org/show_bug.cgi?id=156653 Bug 156653]: Changing the font size has no effect on the separate reader window  ===
  
=== Unify options to enable or disable the tooltips in the folder and message list ===
+
'''Starting point:''' kmreaderwin.cpp, kmreadermainwin.cpp
  
'''Starting point:''' configuredialog.cpp, folderview.cpp, messagelistview/core/view.cpp
+
'''Difficulty:''' Medium
  
'''Difficulty:''' Medium
+
'''Description:''' The font setting has no effect when using a fixed font, and when using the separate reader window. Your job is to fix the situation.
  
'''Description:''' The message list and the folder list both have tooltips that can be enabled or disabled. However, the options for this are not in the same places. The folder list tooltip can be disabled by right-clicking the header of the folder list, while the message list can only be disabled in the configure dialog. Your job is to unify this: add an option to disable the folder list tooltip to the configure dialog, and an option to disable the message list tooltip to the message list header context menu.
+
=== Preserve the image format for HTML inline images ===
  
=== Better handling of empty column titles in the message list ===
+
'''Starting point:''' kdepimlibs/kpimtextedit/textedit.cpp
 
+
'''Starting point:''' messagelistview/core/themeeditor.cpp, messagelistview/core/view.cpp
+
  
 
'''Difficulty:''' Medium
 
'''Difficulty:''' Medium
  
'''Description:''' When using the classic theme, you can select additional columns by right-clicking the header. There are many icon-only columns here, like ''Action Item'' or ''Signature''. For those icon columns, the column header text doesn't fit into the width, and this looks bad. Your job would be to add an option to the theme editor like ''Don't display column header text''. This would simply show nothing as the column header, but still show the column names in the context menu. Also, the default themes should be adjusted to use this.
+
'''Description:''' Currently, when you use embedded HTML images with KMail, those images are always converted to PNG. This is very undesirable when adding photos as inline images, as those are much bigger as PNG.
  
 +
Have a look a textedit.cpp to see what KMail does: When attaching the image, it loads the image file into a QImage and adds that as a resource of the QTextDocument. It also replaces the file name suffix with ".png".
  
 +
Later, when sending the message, that QImage is saved into a QByteArray, saving it into "PNG" format.
  
=== [http://bugs.kde.org/show_bug.cgi?id=156653 Bug 156653]: Changing the font size has no effect on the separate reader window ===
+
To fix this problem, KMail should not change the file name suffix of the image, and later try to use the suffix as format for saving, falling back to PNG if Qt doesn't support saving into that image format.
  
'''Starting point:''' kmreaderwin.cpp, kmreadermainwin.cpp
+
Also, in case of JPEG images, it would be nice to remember the quality as well. QImageReader has to be used to get the quality value.
  
'''Difficulty:''' Medium
+
MessageComposer::imageBodyPart() in kdepim/kmail/messagecomposer.cpp also needs to be fixed to work with other image types.
  
'''Description:''' The font setting has no effect when using a fixed font, and when using the separate reader window. Your job is to fix the situation.
+
=== [http://bugs.kde.org/show_bug.cgi?id=89446 Bug 89446]: Convert more settings to [[Development/Tutorials/Using KConfig XT|KConfigXT]]  ===
  
=== [http://bugs.kde.org/show_bug.cgi?id=71945 Bug 71945]: Refresh IMAP cache even enabled when action can't be used ===
+
'''Starting point:''' kmail.kcfg
'''NOTE: bbigras is working on this, so don't take this for now'''
+
  
'''Starting point:''' kmmainwidget.cpp
+
'''Difficulty:''' Easy (but possibly boring)
  
'''Difficulty:''' Easy
+
'''Description:''' KMail does many manual calls to readEntry() and writeEntry() for reading and saving configuration. These are error-prone and should be ported to the 'new' KConfigXT system, that is already used in some places (you'll notice the ''GlobalSettings'' class being used a lot).
  
'''Description:''' The ''Refresh IMAP Cache'' action in the ''File'' menu is even enabled when there are no IMAP accounts or when no IMAP folder is currently selected. Your job is to fix this be disabling the action when necessary.
+
For a hint see http://websvn.kde.org/?view=rev&revision=1021989
  
=== [http://bugs.kde.org/show_bug.cgi?id=89446 Bug 89446]: Convert more settings to [[Development/Tutorials/Using_KConfig_XT|KConfigXT]] ===
 
  
'''Starting point:''' kmail.kcfg
 
  
'''Difficulty:''' Easy (but possibly boring)
+
=== Update the tips of the day ===
  
'''Description:''' KMail does many manual calls to readEntry() and writeEntry() for reading and saving configuration. These are error-prone and should be ported to the 'new' KConfigXT system, that is already used in some places (you'll notice the ''GlobalSettings'' class being used a lot).
+
''' Starting point:''' kmail/tips
 
+
=== [http://forum.kde.org/kmail-continue-without-create-an-account-t-39090.html In the first run wizard, rename the cancel button] ===
+
 
+
'''Starting point:''' accountwizard.cpp
+
  
 
'''Difficulty:''' Easy
 
'''Difficulty:''' Easy
  
'''Description:''' See the [http://forum.kde.org/kmail-continue-without-create-an-account-t-39090.html forum post]. Basically, when the user sees ''Cancel'', he might think that would quit KMail entirely.
+
'''Description:''' KMail can show a "tip of the day" on each start, or on demand from the Help menu. Those tips are outdated, and we don't have enough tips.
 
+
You should check that the tips are still correct, for example they could refer to the wrong UI elements.
=== [https://bugs.kde.org/show_bug.cgi?id=192897 Bug 192897: Message refers to non-existent UI element] ===
+
 
+
'''Starting point:''' accountdialog.cpp
+
 
+
'''Difficulty:''' Dead Easy
+
 
+
'''Description:''' The message mentioned in the [https://bugs.kde.org/show_bug.cgi?id=192897 bug report] refers to a button at the bottom of the dialog, however the button is in another tab now.
+
Your job is to fix the message to refer to the correct place.
+
 
+
=== [https://bugs.kde.org/show_bug.cgi?id=178402 Bug 178402: Font settings for message list have no effect] ===
+
 
+
'''Starting point:''' configuredialog.cpp, messagelistview/core/themeeditor.cpp, messagelistview/core/themedelegate.cpp
+
 
+
'''Difficulty:''' Medium
+
 
+
'''Description:''' In the configure dialog in KMail, one has the option to change the font of the messages in the message list. However, this setting is not honored, which is a clear bug.
+
 
+
The problem is that the fonts can be configured in two places: In the theme dialog and in the normal configure dialog.
+
  
In the normal dialog, the option of configuring the date field should probably be dropped, since other fields don't have this special treating.
+
Also, we need more tips, currently we have only 9 tips. Anything that is helpful to the user, like increasing productivity, and is not obvious can be added there.
However, the font setting for normal, unread, new, todo and important messages should be honored, at least if the font set in the theme editor is set to "default".
+
Some ideas for new tips:
 +
* The folder selection dialog that comes up when pressing ''J'' or ''M''
 +
* Theme and aggregations can be changed, and that those settings can even be done per folder.
 +
* The dictionary can be changed in the composer with View->Dictionary. Same for the identity.
 +
* Transports can be tied to identities in the identities dialog
 +
* The up and down arrow keys can be used to switch between the fields in the composer
 +
* ... Think of your own!

Latest revision as of 19:45, 5 September 2012

Contents

[edit] KMail Junior Jobs

On this page, you'll find small coding jobs for a beginner to work on. All these problems are relatively easy, some of them might even be one-liners. Of course, it is always a good idea to find your own thing to fix, the best motivation is scratching your own itch.

These tasks are intended for beginners with little or no experience programming with KDE. For those beginners, the biggest challenges are not actually the coding problems, but setting the development environment up, finding the correct place of code where the bug happens (in the jungle of all those source files) and interacting with the community, with the final step being sending the patch.

The knowledge prerequisite for those jobs are not that big. You should be familiar in C++, and knowing Qt a bit would help. Knowing kdelibs or KMail internals is not required, that can usually be picked up during coding.

For more general information, visit the following places:

  • KDE Techbase: Contains a lot of information about developing KDE, in particular a section on how to build KDE from source
  • KMail's HACKING file: Some KMail specific information.

The steps for your first coding contribution are roughly like this:

  1. Build KDE trunk from sources, including KDEPIM
  2. Set up your development environment, i.e. your editor or IDE
  3. Pick something to work on, like some of the things suggested below
  4. Start coding and fix the problem!
  5. Send in a patch (We prefer reviewboard)

Should you need help, feel free to ask us in the #kontact IRC channel, or mail either Thomas McGuire (the KMail maintainer) or the kde-pim mailing list.

Use the KDE commitfilter to subscribe to kdepim and kdepimlibs commits, you will learn a lot from other's commits.

If you find some information missing, feel free to add it to this page after you learn it.

Below follows a list of junior jobs. It always includes a rough location where in the KMail sources to start.

noframe
 
Warning
At this point, KMail 1 is completely frozen. KMail 1 is the version that is shipped with KDE 4.4.x and earlier versions.

Right now, we are working on KMail 2. KMail 2 is the KMail that is based on Akonadi.

Only bugfixes for KMail 1 are still allowed, but no new features or any refactoring.

A good way to contribute would be to help with KMail 2, see first entry below.


[edit] Help making KMail 2 ready

Difficulty: Easy to hard, depends on what you work on

Description: KMail is currently being ported to Akonadi and KMime. This work currently takes place in SVN trunk. Once KMail is fully ported, it will be released as KMail 2, probably together with KDE 4.5.

That porting is a huge task, comparable to the KDE3 to KDE4 port of KMail (if not even more work). Therefore, any help with porting is greatly appreciated. There are still many unported places in the code which are commented out, or places with defects, or missing features. You'll know what I mean with this when you start KMail, you'll immediately notice those things. This is where you can help: Many of those are easy to fix and quite suitable for newcomers. (Side note: the current KMail maintainer started by helping in the KDE3 to KDE4 port, having no experience with KMail code before. I think the Akonadi port is a comparable effort, with quite some low-hanging fruit you can start on.)

We are tracking bugs that are the result of the Akonadi port of KMail with the akonadi-ports-regression keyword. This would be a great place to start: Have a look at the bugs tagged with that keyword and help fixing them. Some of those bugs are huge and difficult tasks, while others are easier. You should probably try starting with the ones that have low priority, those are generally easier. You'll find the bug list with this bugzilla query.

[edit] Bug 156653: Changing the font size has no effect on the separate reader window

Starting point: kmreaderwin.cpp, kmreadermainwin.cpp

Difficulty: Medium

Description: The font setting has no effect when using a fixed font, and when using the separate reader window. Your job is to fix the situation.

[edit] Preserve the image format for HTML inline images

Starting point: kdepimlibs/kpimtextedit/textedit.cpp

Difficulty: Medium

Description: Currently, when you use embedded HTML images with KMail, those images are always converted to PNG. This is very undesirable when adding photos as inline images, as those are much bigger as PNG.

Have a look a textedit.cpp to see what KMail does: When attaching the image, it loads the image file into a QImage and adds that as a resource of the QTextDocument. It also replaces the file name suffix with ".png".

Later, when sending the message, that QImage is saved into a QByteArray, saving it into "PNG" format.

To fix this problem, KMail should not change the file name suffix of the image, and later try to use the suffix as format for saving, falling back to PNG if Qt doesn't support saving into that image format.

Also, in case of JPEG images, it would be nice to remember the quality as well. QImageReader has to be used to get the quality value.

MessageComposer::imageBodyPart() in kdepim/kmail/messagecomposer.cpp also needs to be fixed to work with other image types.

[edit] Bug 89446: Convert more settings to KConfigXT

Starting point: kmail.kcfg

Difficulty: Easy (but possibly boring)

Description: KMail does many manual calls to readEntry() and writeEntry() for reading and saving configuration. These are error-prone and should be ported to the 'new' KConfigXT system, that is already used in some places (you'll notice the GlobalSettings class being used a lot).

For a hint see http://websvn.kde.org/?view=rev&revision=1021989


[edit] Update the tips of the day

Starting point: kmail/tips

Difficulty: Easy

Description: KMail can show a "tip of the day" on each start, or on demand from the Help menu. Those tips are outdated, and we don't have enough tips. You should check that the tips are still correct, for example they could refer to the wrong UI elements.

Also, we need more tips, currently we have only 9 tips. Anything that is helpful to the user, like increasing productivity, and is not obvious can be added there. Some ideas for new tips:

  • The folder selection dialog that comes up when pressing J or M
  • Theme and aggregations can be changed, and that those settings can even be done per folder.
  • The dictionary can be changed in the composer with View->Dictionary. Same for the identity.
  • Transports can be tied to identities in the identities dialog
  • The up and down arrow keys can be used to switch between the fields in the composer
  • ... Think of your own!

This page was last modified on 5 September 2012, at 19:45. This page has been accessed 22,513 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal