Guidelines and HOWTOs: Difference between revisions

From KDE Community Wiki
 
(28 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{ Info |1= All tutorials are to be found here. If you create a new page, create it at  <code>Guidelines_and_HOWTOs/newpage</code>. Do not use a too nested tree, as it is difficult to reorganize. Think of '''adding a link to the new page''' at a relevant place (in the ''Development '' or ''Debugging'' page or what not). }}
[[File:Mascot konqi-support-document.png|thumbnail|right|[[Konqi]] is looking up HOWTOs for you!]]
== Before everything else ==
== Before everything else ==
Before anything, if you want to contribute, you need to [[Infrastructure/Get a Contributor Account|get a contributor account]].
Before anything, if you want to contribute, you need to [https://community.kde.org/Get_Involved  know the various ways to contribute].
 
Also, you can join us at #kde-welcome on [irc://irc.libera.chat/kde-welcome Libera Chat] or on [https://webchat.kde.org/#/room/#kde-welcome:kde.org Matrix]. We're always welcoming more contributors!


== Development ==
== Development ==
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5" class="icon-dark-invert"
|-
|-
| style="padding-left: 50px;" |[[File:Run-build.png |noframe|left|50px|]] ||
||[[File:Run-build.png |noframe|left|50px|]] ||
; [[/Development | For development]]
; [[/Development | For development]]
: Guides and HOW TOs for compiling the sources, creating new programs, sending patches,...
: Guides and HOW TOs for compiling the sources, creating new programs, sending patches,...
|-
|-
| style="padding-left: 50px;" |[[File:Debug-step-out.png|noframe|left|50px|]] ||
||[[File:Debug-step-out.png|noframe|left|50px|]] ||
; [[/Debugging | For debugging]]
; [[/Debugging | For debugging]]
: Guides and HOW TOs to debug applications.
: Guides and HOW TOs to debug applications.
|-
|-
| style="padding-left: 50px;" |[[File:layer-new.png|noframe|left|50px|]] ||
||[[File:layer-new.png|noframe|left|50px|]] ||
; Other
; Other
: Other guides: [[/Relicensing| Relicensing]], [[/Application Versioning|Versioning scheme]]
: Other guides: [[/Relicensing| Relicensing]], [[/Application Versioning|Versioning scheme]], [[/AppStream|AppStream]], [[/MicrosoftStore|Publish in Microsoft Store]]
|-
|-
|}
|}


== Quality, Internationalization, Documentation ==
== Quality, Internationalization, Documentation ==
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5" class="icon-dark-invert"
|-
|-
| style="padding-left: 50px;" |[[File:Internet-amarok.png |noframe|left|50px|]] ||
||[[File:Internet-amarok.png |noframe|left|50px|]] ||
; [[/Internationalization | To internationalize]]
; [[/Internationalization | To internationalize]]
: Guides and HOWTOs concerning the internationalization
: Guides and HOWTOs concerning the internationalization
|-
|-
|}
||[[File:Presentation.png |noframe|left|50px|]] ||
 
; [https://hig.kde.org Human Interface Guidelines]
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
: Recommendations for designing and developing user interfaces
|-
| style="padding-left: 50px;" |[[File:Quality.png |noframe|left|50px|]] ||
; [[/Quality | Quality]]
: Guides and HOWTOs concerning the quality
|-
|-
|}
||[[File:Quality.png |noframe|left|50px|]] ||
 
; [[/Quality | Quality and Documentation]]
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
: Guides and HOWTOs concerning the quality: documentation, [[/Bug_triaging | bug triaging]]...
|-
|-
| style="padding-left: 50px;" |[[File:Documentation3.png |noframe|left|50px|]] ||
||[[File:kstars-satellite.png |noframe|left|50px|]] ||
; [[/Documentation | Documentation]]
; [[/Release | Release]]
: Documentation Manual. -- '''Not''' the [[Guidelines_and_HOWTOs/API_Documentation | API Doc ]]
: Guides and HOWTOs concerning the releasing process.
|-
|-
|}
|}
== Helper Tools ==
;[[Development/Tools/Using kde-config|Get information about KDE's installation - kde-config]]
: The tool kde-config helps to find out more about a KDE installation.
;[[Development/Tools/Using kfmclient|Driving Konqueror From Scripts - kfmclient]]
: kfmclient is a small tool to communicate with Konqueror.
;[[Development/Tools/Using kconf_update|Updating User Configuration Files - kconf_update]]
: kconf_update is a tool designed to update config files.
;[[Development/Tools/svnmerge.py|svnmerge.py]]
: This tool helps keeping track of merges between different SVN branches
;[http://englishbreakfastnetwork.org/ English Breakfast Network] - Static Analysis
: [http://www.englishbreakfastnetwork.org/krazy/ Krazy ] - Code Analysis, [[Development/Tutorials/Code_Checking|Usage Tutorial]]
: [http://www.englishbreakfastnetwork.org/apidocs/ APIDOX] - API Documentation Statistics
: [http://www.englishbreakfastnetwork.org/sanitizer/ Sanitizer] - DocBook Checker
: [http://www.englishbreakfastnetwork.org/usability/ Usability Checks]


== Further resources ==
== Further resources ==
* [[/Further resources | Further resources]]
* [https://community.kde.org/Special:PrefixIndex?prefix=Guidelines_and_HOWTOs&namespace=0 Other Guidelines and HOWTOs]

Latest revision as of 19:50, 23 May 2024

Information

All tutorials are to be found here. If you create a new page, create it at Guidelines_and_HOWTOs/newpage. Do not use a too nested tree, as it is difficult to reorganize. Think of adding a link to the new page at a relevant place (in the Development or Debugging page or what not).
Konqi is looking up HOWTOs for you!

Before everything else

Before anything, if you want to contribute, you need to know the various ways to contribute.

Also, you can join us at #kde-welcome on Libera Chat or on Matrix. We're always welcoming more contributors!

Development

For development
Guides and HOW TOs for compiling the sources, creating new programs, sending patches,...
For debugging
Guides and HOW TOs to debug applications.
Other
Other guides: Relicensing, Versioning scheme, AppStream, Publish in Microsoft Store

Quality, Internationalization, Documentation

To internationalize
Guides and HOWTOs concerning the internationalization
Human Interface Guidelines
Recommendations for designing and developing user interfaces
Quality and Documentation
Guides and HOWTOs concerning the quality: documentation, bug triaging...
Release
Guides and HOWTOs concerning the releasing process.

Further resources