Cómo convertirse en un hacker MediaWiki

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page How to become a MediaWiki hacker and the translation is 50% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎interlingua • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎українська • ‎فارسی • ‎বাংলা • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어

Este artículo está escrito para ayudar a desarrolladores novatos para que aprendan las habilidades necesarias para contribuir al desarrollo de MediaWiki y sus extensiones. En la mayoría de los casos cuando trabajas con MediaWiki, tu no querras modificar MediaWiki a menos que sepas realmente bien lo que está haciendo.

The main path to get started with Wikimedia development is to contribute to Wikimedia projects that offer mentoring. An alternative without mentoring is to fix a good first bug.

Si eres un desarrollador experimentado que posee experiencia con MediaWiki, visita el Centro del desarrollador en cambio.

Para otras maneras de aportar en la comunidad Wikimedia, ve 'Cómo puedes contribuir '.

Resumen

MediaWiki es el software que permite el funcionamiento de Wikipedia, sus proyectos hermanos y miles de wikis en todo el mundo.

MediaWiki está escrito en el lenguaje de programación PHP[1]. Usa jQuery como librería cliente de JavaScript.

MediaWiki está escrito principalmente para la plataforma LAMP[2] y se ejecuta en la mayoría de los sistemas operativos. MediaWiki usa principalmente servidores de MySQL y MariaDB.[3]

Development happens in an open source style[4], is largely coordinated online, and supported by the Wikimedia Foundation, though volunteer community developers play a huge part as well.

La lista principal de desarrolladores es wikitech-l. Los canales del desarrollador son #mediawiki y #wikimedia-dev.

  • Source code is managed using the Git revision control system.[5]

Esta página debería ayudarte a convertirte en un colaborador de MediaWiki. No es un tutorial; justo te señalas a varios sitios donde te puede ir aprender cualquier cosa es necesaria.

Instalando tu ambiente de desarrollo

La mayoría de los proyectos usan Git y Gerrit. Sigue el tutorial de Gerrit para crear tu cuenta de desarrollador. Then you can move on to downloading our code, making changes, testing them, and submitting patches. Hay dos maneras para instalar vuestro entorno de desarrollo: utilizando un pre-máquina virtual configurada setup (vagrant), o manual.

Máquina virtual con Vagrant

  • Instalación de Vagrant - Esto da un paso que instalará el servidor de MediaWiki con todos los requisitos dentro de una máquina virtual con Linux (puede ser utilizado en Linux, Windows, o Hosts de Mac)

Docker development environment

  • MediaWiki Docker – Ejecuta MediaWiki mediante Docker (puede ser usado en Windows, MacOS o Linux)

Instalación manual

  • Requisitos de instalación — Compruebe los requisitos de hardware, e instalar un LAMP, MAMP o WAMP servidor (Linux, Mac o Windows, plus Apache, MySQL/MariaDB y PHP).
  • Descarga desde Git * $download — Descarga el código de fuente más reciente desde Git.
  • Guía de instalación * $guide — Continuar con la instalación y configuración inicial
  • Instalar varios modos de debug en vuestro entorno para mostrar advertencias y errores pronto.

No es necesario descargar vertederos de base de datos de Wikipedia para desarrollar las características de MediaWiki. De hecho, en muchos casos es más fácil de utilizar una cercana-base de datos vacía con unos cuantas páginas de pruebas especiales. Aun así, si para alguna razón quieres tener una copia de Wikipedia, puedes conseguir un vertedero.

Communication tips and guidelines

Watch as a developer fixes a bug in a MediaWiki extension, including investigation, git commit, getting it reviewed and merged, and closing the Bugzilla ticket (now replaced by Phabricator ).
  • Do your research first: When you decide to work on a task, you are expected to do some basic research yourself first: Look at the code, try to get some understanding what it is supposed to do, read related documentation, try to find the probable place(s) where you need to make code changes. For a general overview, please read the Basics to know.
    • In a Phabricator task, see the project tags in the side bar to find out which code repository a task is about.
  • Ask and discuss in the best place:
    • In Phabricator tasks, discuss only specific questions about the topic of that very Phabricator task. General technical questions (e.g. how to set up a development environment or problems with Gerrit) are off-topic in Phabricator tasks.
    • For general technical questions, ask the broader Wikimedia community and use generic channels like IRC chat or mailing lists. (If you take part in an outreach program, then you can also use Zulip's technical-support stream.)
    • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.
  • Ask good questions: "Can you give me more info?", "Please guide me", "Please tell me how to start" are not good comments to start with: The more specific your questions are, the more likely somebody can answer them quickly. If you have no idea at all how to fix the bug, maybe that bug is not (yet) for you – consider finding an easier one first.
  • Provide context: When asking, explain what you want to achieve, and what you have tried and found out already, so others can help at the right level. Be specific – for example, copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words. This avoids misunderstandings. Use specific titles and subject lines ("Proposal draft" or "Need help" is not specific).
  • Use inclusive language: Don't assume anyone's gender identity ("guys", "madam", "sir"). Use the name of the person instead.
  • Ask in public: Do not send private messages if your conversation topic is not secret. Private messages do not help others.
  • Be patient when seeking input and comments, especially during weekends and holidays.
    • On IRC, don't ask to ask, just ask: most questions can be answered by other community members too if you ask on an IRC channel. If nobody answers, please try again at a different time; don't just give up.
    • Do not ask people immediately for code review in a separate message. People receive Gerrit and Phabricator notifications.
  • Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, please avoid unneeded quoting of a complete previous comment. Provide sufficient context and keep threads readable.
  • Follow the code of conduct for Wikimedia technical spaces.
  • When you plan to work on a Phabricator task:
    • No need to ask for permission: Usually there is no reason to ask if you can work on something or if somebody could assign a task to you. There is no authority who assigns tasks or who needs to be asked first.
    • You do not need to announce your plans before you start working on a task but it would be welcome. At the latest when you are close to proposing a patch for a task, it is good to announce that you are working on it, so that others don't duplicate work: If nobody else is already assigned, set yourself as task assignee by using the Add Action… → Assign/Claim dropdown.
    • Tasks with existing patches:
      • If a task already has a recent patch in Gerrit, choose a different task to work on instead – avoid duplicating work.
      • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could also improve that existing patch, based on the feedback in Gerrit and in the task.
    • When your plans or interests change: If you don't work on a task anymore, please remove yourself as the assignee of the task, so others know that they can work on the task and don't expect you to still work on it.

By communicating clearly and early you get attention, feedback and help from community members.

Apéndice

Colaboradores de MediaWiki trabajando en Bangalore, India.

PHP

MediaWiki está escrito en PHP, por lo que necesitarás familiarizarte con PHP para modificar el núcleo de MediaWiki.

Aprende PHP
  • Tutorial de PHP — Disponible en muchos idiomas diferentes. Si no posees conocimientos de PHP pero sabes cómo programar en otros lenguajes de programación orientados a objetos, PHP te resultará sencillo de aprender.
  • PHP Programming at Wikibooks.
  • PHP topic at Wikiversity.
Recursos de PHP
Stuff to know
  • The script maintenance/eval.php in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.
  • Also, the script maintenance/shell.php in MediaWiki is a replacement of maintenance/eval.php based on PsySH, see Manual:Shell.php

Base de datos

Many features require some amount of database manipulation, so you'll often need to be familiar with MySQL/MariaDB.

Aprende MySQL/MariaDB
Recursos de MySQL/MariaDB
Stuff to know
  • Prueba tu código con MySQL/MariaDB.
    • MediaWiki currently uses MySQL and MariaDB as the primary database back-end. It also supports other DBMSes, such as PostgreSQL and SQLite. However, almost all developers use MySQL/MariaDB and don't test other DBs, which consequently break on a regular basis. You're therefore advised to use MySQL/MariaDB when testing patches, unless you're specifically trying to improve support for another DB. In the latter case, make sure you're careful not to break MySQL/MariaDB (or write queries that are horribly inefficient in it), since MySQL/MariaDB is what everybody else uses.

JavaScript y CSS

JavaScript and CSS have become omnipresent in front-end code. You don't have to be familiar with JavaScript, jQuery and CSS to work on MediaWiki, but you might need to, depending on what you choose to work on.

Aprende JavaScript y CSS
Recursos de Javascript y CSS

MediaWiki

The MediaWiki code base is large and some parts are ugly; don't be overwhelmed by it. When you're first starting off, aim to write features or fix bugs which only touch a small region of code.

MediaWiki basics and must-reads
MediaWiki resources

Extensiones MediaWiki

If you choose to work on MediaWiki extensions code, the following links provide more information.

MediaWiki extensions basics:
MediaWiki extensions resources:

Véase también

  1. No todo MediaWiki está escrito en PHP. Existen algunas herramientas adicionales que están escritas en otros lenguajes, incluyendo archivos batch, script shell, makefiles y Python.
  2. MediaWiki puede ejecutarse en la mayorías de las plataformas que soportan PHP, sin embargo, la falta de algunos programas utilitarios o características del sistema operativo pueden limitar la funcionalidad o rendimiento de MediaWiki en plataformas que no son LAMP.
  3. MediaWiki posee soporte para más gestores de bases de datos, incluyendo a Oracle, PostgreSQL, SQLite y Microsoft SQL Server.
  4. Developers are a mix of volunteers and paid staff (or contractors) for various organizations. For a full list of who works on the MediaWiki code, read the Developers article.
  5. Browse the source code and revisions of code repositories at https://phabricator.wikimedia.org/diffusion/ or download the source code to your system by using Gerrit.