Guidelines and HOWTOs: Difference between revisions

From KDE Community Wiki
(Add links to #kde-welcome channels)
(43 intermediate revisions by 5 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 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 [http://webchat.freenode.net/?channels=kde-welcome Freenode] 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"
Line 9: Line 16:
; [[/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|]] ||
; Other
: Other guides: [[/Relicensing| Relicensing]], [[/Application Versioning|Versioning scheme]], [[/AppStream|AppStream]]
|-
|-
|}
|}


== Internationalization (i18n) Tools ==
== 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"
|-
|-
Line 18: Line 29:
; [[/Internationalization | To internationalize]]
; [[/Internationalization | To internationalize]]
: Guides and HOWTOs concerning the internationalization
: Guides and HOWTOs concerning the internationalization
|-
|}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
| style="padding-left: 50px;" |[[File:Presentation.png |noframe|left|50px|]] ||
; [https://hig.kde.org Human Interface Guidelines]
: Recommendations for designing and developing user interfaces
|-
|-
|}
|}


== Helper Tools ==
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
| style="padding-left: 50px;" |[[File:Quality.png |noframe|left|50px|]] ||
; [[/Quality | Quality and Documentation]]
: Guides and HOWTOs concerning the quality: documentation, [[/Bug_triaging | bug triaging]]...
|-
|}


;[[Development/Tools/Using kde-config|Get information about KDE's installation - kde-config]]
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
: The tool kde-config helps to find out more about a KDE installation.
|-
 
| style="padding-left: 50px;" |[[File:kstars-satellite.png |noframe|left|50px|]] ||
;[[Development/Tools/Using kfmclient|Driving Konqueror From Scripts - kfmclient]]
; [[/Release | Release]]
: kfmclient is a small tool to communicate with Konqueror.
: Guides and HOWTOs concerning the releasing process.
 
|-
;[[Development/Tools/Using kconf_update|Updating User Configuration Files - kconf_update]]
|}
: kconf_update is a tool designed to update config files.
 
;[[Development/Tools/apidox|Generating apidox]]
: tools that help develop and generate API documentation for your code.
 
;[[Development/Tools/svnmerge.py|svnmerge.py]]
: This tool helps keeping track of merges between different SVN branches
 
== Quality Assurance ==
 
;Project Management
: KDE is transitioning to [https://phabricator.kde.org Phabricator] for project management.  You can get started with Phabricator on the [[Infrastructure/Phabricator|Phabricator]] .  The older [http://www.reviewboard.org/ Review Board] is limited to code reviews only: see [[Infrastructure/Review_Board|here]] for more details.
 
;Continuous Building - Jenkins
: [http://build.kde.org Jenkins]
: [http://public.kitware.com/dashboard.php?name=kde kdelibs on kitware]
 
;[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]
 
== HOWTOs ==
=== Development ===
* [[/Git| Use Git]]
* [[/Build_from_source| Build from source]]
* [[/CMake| Use CMake]]
* [[/Debug | Debug a program]]
* [[Infrastructure/Get a Contributor Account|Get a Contributor Account]]
 
== Localization ==
 
== To move here ==
[[Applications/Versioning]]


== Further resources ==
== Further resources ==
* [[/Further resources | Further resources]]
* [[/Further resources | Books, websites, resources]]

Revision as of 13:49, 4 June 2019

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 Freenode 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

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