diff --git a/content/contribute/_index.md b/content/contribute/_index.md index 7edf77161..25e6931d5 100644 --- a/content/contribute/_index.md +++ b/content/contribute/_index.md @@ -1,85 +1,85 @@ --- date: "2017-03-21" title: "Contribute" author: "digiKam Team" description: "Contribute to the digiKam project" category: "donate" aliases: "/contrib" menu: "navbar" --- The easiest way to contribute is to spread the word about digiKam. We also encourage you to test digiKam, report bugs, and submit feature requests. You might also want to subscribe to the [digikam-users](https://mail.kde.org/mailman/listinfo/digikam-users) mailing list and help other digiKam users with their questions and problems. ## Reporting Bugs and Submitting Feature Requests Use the bug tracking system for all bug reports and new feature requests. Take a look at the [support page](/support) for further information. ## Dealing with Crashes in digiKam In case digiKam crashes, you can provide a backtrace using GDB debugger. digiKam needs to be compiled with all debug info; otherwise the backtrace will be useless. If you installed digiKam using the packages provided by your distribution, make sure to install the corresponding debug package. [The debugging guide](https://community.kde.org/Guidelines_and_HOWTOs/Debugging) provides further information on debugging. Instructions how to get into GDB on various platforms are below. When you are in GDB and digiKam crashes, you will get to the GDB command prompt. If digiKam "just" freezes, press ctrl-c to get to the GDB prompt. Once you are at the prompt, use the bt command, copy the backtrace and exit GDB as shown here: ``` (gdb) bt (gdb) _the backtrace is here_ (gdb) quit ``` On Linux if you use a regular binary, i.e. no AppImage, use the following command to get into GDB and start digiKam: ``` $ gdb digikam (gdb) catch throw (gdb) run ``` If you use an AppImage, replace the name of the AppImage with the one you have and run: ``` $ digikam-5.7.0-01-x86-64.appimage debug ``` On Windows, the binary installer comes with a [DrMinGw crash course handler](https://vroby.ddns.net/Public/sdlBasic/MinGW/doc/drmingw/drmingw.html), which will generated a file backtrace in you home directory as below: C:\Users\_user_name_\AppData\Local\digikam_crash.log Under MacOS, users can run **lldb** debugger as follows: lldb /opt/digikam/Applications/KF5/digikam.app/Contents/MacOS/digikam ## Checking for Memory Leaks To check for memory leaks in digiKam, use the [valgrind](http://valgrind.org) tool. Run the command below, and report the trace to developers: valgrind --tool=memcheck --leak-check=full --error-limit=no digikam ## Freezes and Other Issues On Linux, run digiKam from the command line to get the output generated by the application. On macOS, digiKam executable is installed in _/opt/digikam/Applications/KF5/digikam.app/Contents/MacOS/digikam_, and you can use it to start the application from the command line to view debug traces. On Windows, trace is not sent to the console. You need to install [DebugView tool](http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx) to capture debug traces generated by digiKam. ## Submitting Patches -Before you submit patches, please read the [HACKING file](https://cgit.kde.org/digikam.git/tree/HACKING). Send patches against the current version of the code (latest git/master revision) and not the stable release or an old beta version. Patches can be created using the following command: +Before you submit patches, please read the [HACKING section](https://www.digikam.org/api) from online API documentation. Send patches against the current version of the code (latest git/master revision) and not the stable release or an old beta version. Patches can be created using the following command: git diff HEAD > mydiff.patch -The patches must be attached to a new entry in [Bugzilla](https://www.digikam.org/support). Please do not use mailing lists or private mail. +The patches must be attached to a new entry in [Bugzilla](https://www.digikam.org/api/index.html#sourcedirs). Please do not use mailing lists or private mail. ## Translations If you want to contribute to the digiKam internationalization effort, contact the translation teams at [http://l10n.kde.org/](http://l10n.kde.org/). Also, please read the [Translation HOWTO](http://l10n.kde.org/docs/translation-howto/). ## Documentation Help with digiKam documentation is always welcome. For all documentation-related matters, write to [digiKam-devel mailing list](https://mail.kde.org/mailman/listinfo/digikam-devel). Our [documentation](http://docs.kde.org/development/en/extragear-graphics/digikam/index.html) is based on the [docbook format standard](http://l10n.kde.org/docs/doc-primer/index.html). The [README](https://cgit.kde.org/digikam-doc.git/tree/README) file explains in detail how structure the documents, take screenshots, etc. It's also possible to submit additions and changes in the ASCII format. To do this, create a new Bugzilla entry with a patch against git/master code, so it can be incorporated in the documentation. ### Pictures Samples We need raw and JPEG files from different manufacturers (Canon, Nikon, Sony, Olympus, Sigma, etc.). We use these files to analyze embedded metadata to improve camera support in digiKam. We also need sample files produced by different applications (including other platforms and proprietary software like Adobe Photoshop) that include IPTC/XMP metadata. This can help us to improve compatibility with other tools and implement automatic import of this data into the digiKam database. ## Splash Screens As a photographer, you can submit your best photos for use as digiKam splash screen. Take a look [at this page](http://www.digikam.org/splashcreens) for further information.