Help:Contribuer

From KDE TechBase
Revision as of 12:16, 18 May 2019 by ChristianW (talk | contribs)
Other languages:

Cette page contient des informations concernant la manière de modifier le wiki TechBase de KDE, y compris l'emplacement des contenus ainsi que des outils spécifiques adaptés à ce wiki. Même si vous êtes familier avec les wikis, vous pouvez relire la section sur l'organisation pour savoir où placer votre contenu sur ce wiki.

Avant de commencer

Les premières choses d'abord

  • Notez bien que vous devez accepter que vos contributions à ce wiki soient placées sous les licences listées sur KDE TechBase:Copyrights. Ces licences signifient que ce que vous produisez peut être par exemple, recopié vers d'autres sites.
  • Utilisez les pages de discussion (Talk pages) pour communiquer avec les autres contributeurs ou pour demander de l'aide. Normalement quelqu'un vous répondra dans la journée.

Que trouve-t-on ici ?

Ce wiki concerne la documentation des développeurs voulant utiliser ou étendre les produits KDE (via les API) , ainsi que :

  • les informations générales sur les bibliothèques, y compris les avantages en les utilisant
  • les tutoriels et les exemples d'utilication des bibliothèques
  • les tutoriels, les exemples et la documentation pour écrire des plugins et d'autres extensions aux bibliothèques et aux applications
  • les interfaces IPC/RPC pour le logiciel, comme les interfaces de DBus


La documentation de l'utilisateur final est à placer dans le wiki UserBase. Les sujets relatifs aux contributeurs, aux équipes et à la communauté KDE en général sont dans le wiki de la communauté.

Exemples de ce qu'il ne faut pas mettre sur le wiki TechBase  :

  • la documentation sur la manière d'utiliser une application
  • les règles d'écriture du code
  • les informations pour les nouveaux contributeurs
  • la coordination de l'équipe (listes TODO à faire, les notes des réunions, etc...)
  • les notes sur l'architecture interne d'un morceau de logiciel (mais on peut mettre ici l'architecture de l'API d'une bibliothèque)

Vous pouvez lire les instructions sur community.kde.org

Organisation

noframe
noframe
 
À faire :
besoin de documenter la structure

La mise en page

Maintenance du Wiki

Maintaining a clean and useful wiki involves making sure content is up to date, there are no broken links, and all pages can be found (they are linked to from somewhere). The following special pages can help find issues that need fixing:

Issues which should be fixed as soon as possible
Special:Lonelypages
Special:BrokenRedirects
Special:DoubleRedirects
Issues which should be fixed in time
Special:Wantedpages
Special:Wantedcategories

You can also add a page to the Needs Attention to flag it for later work by adding [[Category:Needs Attention]] to the page. Using Template:TODO will also add a page to this category.

Supprimer des pages

La plupart des utilisateurs ne peuvent pas supprimer les pages du Wiki - ceci est dû au fait que une fois que la page a été supprimée, vous ne pouvez pas la restituer. Si vous pensez qu'une page doit être supprimée, marquez la en insérant le modèle Template:Proposed_deletion tout au début en indiquant, en anglais dans 'reason=', le motif de la supression :

{{Proposed_deletion|reason=this page contains only spam}}