Aide:Extension:Translate/Commencer à développer

This page is a translated version of the page Help:Extension:Translate/Getting started with development and the translation is 65% complete.

Merci de vous intéresser au développement de l’extension Translate. Le but de ce document est de rendre plus facile les premiers pas dans le développement de l’extension Translate.

Développer l’extension Translate nécessite la connaissance de PHP, JavaScript/jQuery et de CSS/LESS. Certaines connaissances en MySQL peuvent être nécessaires, selon la tâche sur laquelle vous voulez travailler.

Apprivoiser le code

Les pages suivantes devraient vous donner un bon aperçu de l’ensemble du code :

  1. Différents composants de l’extension Translate
  2. Glossaire : description de la terminologie utilisée
  3. Structure des espaces de noms PHP
  4. Les différentes options de configuration proposées par Translate
  5. Les tâches (jobs) MediaWiki utilisés dans Translate

Installer localement une version de développement

The easiest way to get started with development on Translate extension is to use the MediaWiki-Docker . Please see the instructions here.

To run some code sniffs specific to Translate extension, you can run composer install inside the Translate extension directory. You can use the following command: docker-compose exec mediawiki sh -c "cd extensions/Translate && composer install"

Conventions de codage

Translate follows the existing MediaWiki Coding conventions. These differ based on the programming languages, so ensure you go through the appropriate pages.

There are a few other guidelines specific to Translate to keep in mind.

Décider sur quoi travailler

Go to the Translate Phabricator Board and look for tasks with the tag: good first tasks.

Because the extension is actively being worked on, before you start work on a task, we recommend leaving a comment about any additional concerns that are not reflected in the task currently.

After you receive the green light, you can go ahead and assign the task to yourself and start working.

Liste de contrôle de l'envoi des corrections

Il est important d’être familier avec les procédures de Gerrit. Il faut aussi connaitre les conventions sur les messages de commit.

Avant de soumettre un correctif, il est recommandé de lancer les outils d’épluchage (linting) et d’effectuer les tests localement afin de vérifier et corriger les problèmes simples. Cela réduit les allers-retours pendant la revue de code.

  1. Exécutez phpcbf pour corriger les problèmes de mise en forme facilement corrigeables localement. Cela peut être fait avec : docker-compose exec mediawiki composer fix extensions/Translate
  2. Exécutez les autres éplucheurs pour identifier tout problème qui n’a pas pu être corrigé automatiquement. Cela peut être fait avec : docker-compose exec mediawiki sh -c "cd extensions/Translate && composer test"
  3. Exécutez les cas de test de l’extension Translate : docker-compose exec mediawiki sh -c "php tests/phpunit/phpunit.php extensions/Translate/tests/phpunit/"

Autres liens utiles