MediaWiki

Cómo convertirse en un hacker MediaWiki

This page is a translated version of the page How to become a MediaWiki hacker and the translation is 51% complete.
Outdated translations are marked like this.
Other languages:

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 connect y #wikimedia-dev connect.

  • Source code is stored on Gerrit and managed using the Git revision control system and can be viewed here[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.

Docker development environment

  • MediaWiki Docker – Ejecuta MediaWiki mediante Docker (puede ser usado en Windows, MacOS o Linux) This is the recommended method.

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker containers.

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)

Vagrant is a powerful tool, but it is more complex and less robust than Docker, and significantly more resource-intensive. It is mainly aimed at developers who need to set up complex, flexible environments, e.g. for testing the interaction of multiple extensions.

Instalación manual

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 ).

Follow these tips to communicate effectively and get help from community members.

Use Phabricator tasks effectively

When you plan to work on a Phabricator task:

  • No need to ask for permission: You can work on unassigned tasks without asking someone to assign them to you. There is no authority who assigns tasks or who needs to be asked first.
    • If a task already has a recent patch in Gerrit, choose a different task to work on instead.
    • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could improve that existing patch, based on the feedback in Gerrit and in the task.
  • Do your research: When you consider working on a task, do research before you start coding. Look at the code, try to understand what it is supposed to do, read related documentation, and try to find the places where you need to make code changes.
    • In a Phabricator task, use the project tags in the side bar to find the code repository for the task.
    • If you have no idea at all how to fix the bug, consider finding an easier one first.
  • You do not need to announce your plans before you start working on a task, but you should communicate that you are working on the task.
    • When you start work, set yourself as task assignee by clicking Edit Task… in Phabricator, and set your Phabricator username in the Assigned To field. This communicates to others that you are working on it, so they don't duplicate work.
    • When your plans or interests change: If you are no longer working on a task, remove yourself as the assignee of the task. This tells others that they can work on the task, and they won't expect you to still work on it.
  • Follow Phabricator etiquette.
    • In Phabricator tasks, discuss only specific questions about the topic of that task. Don't use Phabricator to ask general questions, like how to set up a development environment or how to fix problems with Gerrit.

Compose good questions

  • Don't ask to ask...just ask!.
  • Be specific and provide context: Instead of simply asking "Can you give me more info?", "Please guide me", or "Please tell me how to start", include the following information in your question:
    • What are you trying to achieve?
    • What have you already tried? Copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words.
    • What have you found out already during your research? Include links to code, documentation, or other resources you already consulted.
  • Use specific titles and subject lines in your communication. "Proposal draft" or "Need help" is not specific.
  • Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, only quote sections of previous comments that are relevant to your response. If you quote a complete previous comment, it makes threads hard to read.

Follow communication policies and best practices

Before you send or post your question:

Ask in the right place

  • Ask in public: Do not send private messages if your conversation topic is not secret. Private messages don't help others.
  • Ask and discuss in the best place:
    • In Phabricator tasks, discuss only specific questions about the topic of that task.
    • Ask general technical questions, like how to set up a development environment or how to fix problems with Gerrit, in the places listed on Comunicación .
    • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.

Be patient

After you post your question:

  • Do not ask people for code review in a separate message. People receive Gerrit and Phabricator notifications and will respond when they can.
  • When seeking input and comments, especially during weekends and holidays, you may need to wait until business hours resume. On chat channels like IRC: if nobody answers, try again at a different time; don't just give up!
  • If you don't get an answer even after waiting and being patient, consider if other Communication channels might be a better place to ask your question.

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 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 Desarrolladores 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.
Retrieved from "https://www.mediawiki.org/w/index.php?title=How_to_become_a_MediaWiki_hacker/es&oldid=5349107"