How to become a MediaWiki hacker/pt

Este artigo é escrito para ajudar desenvolvedores iniciantes a aprender habilidades necessárias para contribuir com o desenvolvimento da MediaWiki.

Se você for um desenvolvedor experiente, visite ao invés disso, .

Perspectiva
MediaWiki é o software que potencia o Wikipedia, seus projectos irmãos e milhares de wikis ao redor do mundo. Isto roda na maioria de sistemas operativos, é escrito em PHP, primeiramente usa o servidor de base de dados MySQL e MariaDB, e usa o jQuery como livraria de JavaScript para o utilizador. Desenvolvimento do MediaWiki é primeiramente apoiada pela Wikimedia Foundation, embora a comunidade voluntária de desenvolvedores participem em grande medida também.

Esta página poderia ajudar a levá-lo ao caminho para se tornar em um colaborador do MediaWiki. Isto não é um tutorial; Isto apenas indica-o a vários locais onde você ir aprender o quer que seja necessário.

Iniciando
Primeiro de tudo, obtenha o  and Gerrit tutorial para descarregar o nosso código, teste e comece por submeter as correcções. Existe duas formas de configurar o ambiente de desenvolvimento: usando o instalador pré-configurado da máquina virtual (vagrant), ou manual.

Máquina Virtual com Vagrant

 * Instalação do Vagrant - Estes passos instalarão o servidor MediaWiki com todos os requerimentos dentro de uma máquina virtual Linux (pode ser usada em anfitriões Linux, Windows, ou Mac)

Instalação Manual

 * requisitos da instalação — Verifique os requisitos de hardware, e instale um dos servidores LAMP, MAMP ou WAMP (Linux, Mac ou Windows, mais Apache, MySQL/MariaDB e PHP).
 * — Descarregue o último código fonte de Git.
 * — Continue com a instalação e a configuração inicial.
 * Configure o vários modos de depuração para visualizar alertas de erros antecipadamente.

Não é necessário descarregar a base de dados acumulada da Wikipedia para desenvolver características ou funcionalidades da MediaWiki. Na verdade, em vários casos é mais fácil uma base de dados quase vazia com poucas páginas de testes especificamente feitas. Contudo, se por alguma razão quiser ter a cópia do Wikipedia, poderá Obter um acúmulo.

Leituras sugeridas


Recomendações gerais
Se escolher trabalhar em uma publicação de erro que requer escrever ou alterar o código, deverá querer no mínimo reduzir as páginas antes:

 
 * Os dois caminhos para iniciar com o desenvolvimento MediaWiki é reparar um erro pequeno e irritante em um código existente, ou adicionar uma nova característica, geralmente através de uma extensão da MediaWiki.
 * Convenção de códigos e qualquer sub-páginas relevantes para sua tarefa (,, ,...)
 * Following the linhas guias de mensagem de execução, especialmente a secção Exemplo abaixo, automaticamente adicionará notificações acerca de suas correcções à publicação correspondente em . Deste modo não haverá mais necessidade de adicionar o comentário "Please review" na publicação.
 * Verifique o seu código fronte a '''lista de pre-execução. Não salte este passo ; Ficará feliz por não o ter feito.
 * Obtendo códigos revistos. Procure e adicione pessoas como potenciais revisores para de suas correcções.
 * Emendar a alteração Não crie novas configurações de mudanças Gerrit para rectificar a anterior!
 * Na maioria dos casos quando estiver a trabalhar com MediaWiki, você Não queira hackear as funcionalidades principais de MediaWiki a menos que realmente saiba o que está a fazer.

Comentários, perguntas e assistência
 
 * É esperado que faça pesquisas básicas por si mesmo primeiro: Verifique o código, tente obter alguma percepção do que é suposto ser, ler documentos relacionados, tente encontrar lugares prováveis onde se precisa de se efectuar alterações de formas a reparar os erros.
 * Se você tiver dúvidas gerais sobre a infraestrutura, a arquitectura de software ou fluxos de trabalho que não estão ligados a um erro específico que queira trabalhar nele, use canais genéricos como, mailing lists, ou páginas de discussão. Por exemplo, se tiver problemas com a Gerrit, a Página de discussão da Gerrit poderá ser um bom lugar para perguntar.
 * Se você tiver dúvidas específicas acerca do erro em si, comente na publicação correspondente . O que devo fazer para rectificar este erro? não é um boa pergunta para começar: Quanto mais específico a sua pergunta for, mais probabilidade existirá de alguém poder respondê-la rapidamente. Se tiver não tiver ideia gera de como rectificar o erro, este erro poderá (ainda) não ser para si - por favor considere procurar um mais fácil, primeiro.
 * When asking, elaborate what you have tried and found out already, so others can help at the right level. Try to 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.
 * Avoid private email or support requests in our social media channels.
 * Please be patient when seeking input and comments. 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 ask on the bug report or wiki page related to the problem; don't just drop the question.
 * Learn more at.

Communicate that you work on a bug
You do not need to be set as the assignee in a bug report or announce your plans before you start working on a bug, but it would be welcome. At the latest when you are close to creating a patch for the bug, it is good to announce in a comment that you are working on it. Your announcement also helps others to not work on the bug at the same time and duplicate work.

Also note that if a bug report already has a recent link to a patch in Gerrit and has the project "Patch-For-Review" associated, you should choose a different bug to work on instead - avoid duplicating work. If the patch in Gerrit has not been merged and has not seen any changes for a long time, you could also pick up that existing patch and try to improve it.

If you stop working on a task you should remove yourself as the assignee of a bug report and reset the assignee to the default assignee, so others know that they can work on the bug report and don't expect you to still work on it.

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

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


 * MediaWiki extensions primers:
 * Developing extensions — How to write an extension for MediaWiki.
 * Writing an extension for deployment — If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security.
 * Extension writing tutorial


 * MediaWiki extensions resources:
 * List of simple extensions — A simple way to become more familiar with how extensions work.
 * A brief introduction to MediaWiki extension development — A video presentation about how to create a MediaWiki extension (slides).
 * Making a MediaWiki extension — Covers how to develop an extension for Mediawiki, best practices, and how to engage the Mediawiki community. From February 2011.
 * Special page template — Add a special page to display some handy information.
 * Extending wiki markup — Add a parser hook to modify the content of wikitext.

PHP
MediaWiki is written in PHP, so you'll need to get familiar with PHP to hack MediaWiki's core.


 * Learn PHP
 * PHP tutorial — Available in many different languages. If you have no knowledge of PHP but know how to program in other object-oriented programming languages, PHP will be easy for you to learn.
 * PHP Programming at Wikibooks.
 * PHP topic at Wikiversity.


 * PHP resources:
 * The PHP manual — Available in many different languages.
 * PHP coding conventions within the MediaWiki community.


 * Stuff to know:
 * The script  in MediaWiki provides a basic PHP interpreter with MediaWiki objects and classes loaded.

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


 * Learn MySQL/MariaDB
 * MySQL tutorial — From the MySQL 5.0 reference manual.
 * MySQL at Wikibooks.


 * MySQL/MariaDB resources
 * MySQL Reference Manuals — Available in many different languages.
 * MariaDB Knowledge Base
 * Database coding conventions within the MediaWiki community.


 * Stuff to know:
 * Test your code with 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 and 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.


 * Learn JavaScript and CSS
 * JavaScript and CSS at Wikibooks.
 * Getting Started with jQuery — A jQuery tutorial.


 * JavaScript and CSS resources
 * JavaScript coding conventions within the MediaWiki community.
 * CSS coding conventions within the MediaWiki community.

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 are constrained to a small region of code.


 * MediaWiki primers and must-reads:
 * MediaWiki architecture — A high-level overview of the main components of MediaWiki and how they work with each other.
 *  — An overview of why and how to write secure code.


 * MediaWiki resources:
 * — A list of important files and links to more detailed information.
 * — A list of hooks. If you're trying to find what part of the codebase does something, often a good place to start is by searching for the related hooks.
 * — An overview of general coding conventions within the MediaWiki community.
 * Intro-to-MediaWiki workshop syllabus — Ways to hack MediaWiki, from user preferences to extensions and core.
 * Code documentation — Automatically generated documentation from the code and code comments.
 * — A guide to debugging MediaWiki.
 * — A tool to interact with MediaWiki objects live.