How to become a MediaWiki hacker/pt

Este artigo foi escrito para ajudar os programadores a adquirirem os conhecimentos básicos necessários para contribuírem para o desenvolvimento do núcleo do MediaWiki e das extensões do MediaWiki. Note que, na maioria dos casos, ao trabalhar no MediaWiki não quer mexer no núcleo central do MediaWiki a menos que saiba verdadeiramente o que está a fazer.

A principal forma de se iniciar no desenvolvimento da Wikimedia é contribuir nos projetos Wikimedia que oferecem orientação. Uma forma alternativa sem orientação é corrigir um defeito pequeno mas irritante.

Se já é um programador experiente, familiarizado com o uso do MediaWiki, visite antes .

Para outras formas de se envolver na comunidade Wikimedia, consulte .

Sinopse
O MediaWiki é o software que é utilizado pela Wikipédia, os seus projetos associados e milhares de wikis por todo o mundo.

O MediaWiki está escrito na linguagem de programação PHP. Este utiliza jQuery como a biblioteca cliente de JavaScript.

O MediaWiki está escrito principalmente para a plataforma LAMP e executado na maioria dos sistemas operativos. O MediaWiki utiliza principalmente os servidores de bases de dados MySQL ou MariaDB.

O desenvolvimento é efetuado com código aberto, é coordenado em grande medida online, e é suportado pela Fundação Wikimedia, embora os programadores voluntários da comunidade também desempenhem um papel muito importante.

Esta página deve ajudá-lo a tornar-se num colaborador do MediaWiki. Ela não é um guia prático; indica-lhe apenas os vários locais onde poderá aprender o que quer que seja necessário.
 * A discussão de desenvolvimento ocorre em várias listas de discussão e nos canais de IRC. A lista de programadores principal é wikitech-l. Os principais canais de desenvolvimento são o #mediawiki e o #wikimedia-dev.
 * Código fonte é gerido utilizando o sistema de controlo de versões Git.
 * As revisões do código são efetuadas no . Siga este tutorial para configurar o Git e o Gerrit para poder submeter correções de código.
 * Os relatórios de defeitos e as tarefas relacionadas são geridos no Phabricator.

Configurar o seu ambiente de desenvolvimento
A maioria dos projetos utilizam o Git e o Gerrit. Siga o guia prático do Gerrit para configurar a sua conta de desenvolvimento. Depois poderá descarregar o nosso código, fazer alterações, testá-las e enviar modificações. Há duas formas de configurar o seu ambiente de desenvolvimento: usar o instalador de uma máquina virtual pré-configurada (Vagrant ou Docker), ou uma abordagem de configuração manual.

Máquina Virtual com Vagrant

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

Ambiente de desenvolvimento Docker

 * MediaWiki Docker Dev - Executar o MediaWiki usando Docker (pode ser usado em servidores Linux, Windows e MacOS).

Instalação manual

 * Requisitos de instalação — Verifique os requisitos de hardware, e instale um servidor LAMP, MAMP ou WAMP (Linux, Mac ou Windows, mais Apache, MySQL/MariaDB e PHP).
 * — Descarregue o código fonte mais recente a partir do Git.
 * — Prossiga com a instalação e a configuração inicial
 * Configure os vários modos de despiste de erros no seu ambiente para apresentarem os alertas e erros cedo.

Não é necessário descarregar cópias em ficheiro da base de dados da Wikipédia para desenvolver funcionalidades do MediaWiki. Na verdade, muitas vezes é mais fácil usar uma base de dados quase vazia, só com poucas páginas de testes especificamente criadas. Contudo, se por alguma razão quiser ter uma cópia da Wikipédia, pode obter uma cópia em ficheiro.

Leitura sugerida


Comentários, perguntas e apoio

 * É esperado que comece por fazer alguma investigação básica: analise o código, tente compreender o que este pretende fazer, leia a documentação relacionada, tente encontrar o sítio ou sítios no código onde provavelmente terá de efetuar alterações para corrigir o defeito.
 * Se tiver dúvidas gerais que não estão ligadas à tarefa específica em que quer trabalhar, use canais genéricos como o Apoio aos Programadores da Wikimedia, IRC ou as listas de divulgação e não a tarefa específica.
 * Se tiver dúvidas específicas acerca do defeito, comente no relatório correspondente (que normalmente é uma tarefa no ). Podem dar-me mais informação sobre como reparar este defeito? não é uma boa pergunta inicial: quanto mais específicas as suas perguntas forem, maior será a probabilidade de alguém conseguir respondê-las rapidamente. Se não faz qualquer ideia de como reparar o defeito, talvez este defeito (ainda) não seja para si - tente encontrar outro mais fácil primeiro, por favor.
 * Ao colocar uma pergunta, descreva aquilo que já tentou e descobriu, para que os outros o possam ajudar ao nível adequado. Seja específico - por exemplo, copie e insira os seus comandos e os respetivos resultados (se não forem muito longos) em vez de parafrasear nas suas próprias palavras. Isto evita mal-entendidos.
 * Evite mensagens privadas ou pedidos de ajuda nos nossos canais nas redes sociais.
 * Seja paciente quando procura opiniões e comentários. No IRC não pergunte se pode perguntar, faça logo a pergunta; a maioria das questões podem ser respondidas por outros membros da comunidade se forem colocadas num canal IRC. Se ninguém responder, coloque a pergunta na página do relato de defeito ou numa página wiki relacionada com o problema; não desista da pergunta.
 * Aprenda mais em.
 * Também pode colocar qualquer pergunta semanalmente na Reunião do IRC para Apoio Técnico no canal #wikimedia-tech no Freenode IRC.



Comunique que está a trabalhar numa tarefa
Não é preciso perguntar se pode trabalhar numa tarefa. Não é preciso anunciar os seus planos antes de começar a corrigir um defeito, mas seria bom se o fizesse. Pode reivindicar a responsabilidade por uma tarefa: use o menu Adicionar ação ... → Atribuir/Reivindicar no Phabricator. O mais tardar quando estiver prestes a propor uma modificação de código relacionada com uma tarefa, é bom anunciar num comentário que está a trabalhar nela. O seu anúncio ajuda os restantes a não trabalharem na correção do mesmo defeito e não desperdiçarem esforço.

Note também que se uma tarefa já tem uma hiperligação recente com a correção do erro no Gerrit e tem associado o projeto "Patch-For-Review" no Phabricator, deve trabalhar numa tarefa diferente - evite o trabalho em duplicado. Se uma correção existente no Gerrit não tiver sido fundida e não sofre alterações há muito tempo, pode ficar com a correção existente e tentar melhorá-la, com base nos comentários do Gerrit e na tarefa.

Se parar de trabalhar numa tarefa, remova o seu nome como responsável pela tarefa, de modo que os restantes saibam que podem trabalhar na tarefa e não julguem que você ainda está a trabalhar nela.

Se comunicar cedo obterá mais atenção, comentários e ajuda dos membros da comunidade. 

PHP
O MediaWiki está escrito em PHP, portanto tem de se familiarizar com o PHP para programar o núcleo central do MediaWiki.


 * Aprenda PHP
 * Guia prático de PHP — Disponível em muitas línguas diferentes. Se não tem nenhum conhecimento de PHP mas sabe programar noutras linguagens de programação orientada para objetos, será fácil para si aprender PHP.
 * PHP Programming at Wikibooks.
 * PHP topic at Wikiversity.


 * Recursos de PHP:
 * O manual de PHP — Disponível em muitas línguas diferentes.
 * Convenções de código PHP na comunidade MediaWiki.


 * Coisas a saber:
 * O script  no MediaWiki fornece um interpretador básico de PHP com objetos e classes MediaWiki carregados.
 * Adicionalmente, o ficheiro de comandos  no MediaWiki substitui o   baseado em PsySH; consulte Manual:Shell.php.

Base de dados
Muitas funcionalidades requerem alguma manipulação da base de dados, portanto precisará frequentemente de conhecer MySQL ou MariaDB.


 * Aprender MySQL/MariaDB
 * Guia prático de MySQL — Do manual de referência do MySQL 5.0.
 * MySQL at Wikibooks.


 * Recursos de MySQL/MariaDB.
 * Manuais de referência de MySQL — Disponível em muitas línguas diferentes.
 * Base de Conhecimentos (Knowledge Base) MariaDB.
 * Convenções para código de base de dados na comunidade MediaWiki.


 * Coisas a saber:
 * Teste o seu código com MySQL/MariaDB.
 * O MediaWiki usa atualmente MySQL e MariaDB como servidor principal da base de dados. Também suporta outros Sistemas de Gestão da Base de Dados (DBMSes), tal como PostgreSQL e SQLite. Contudo, a maioria dos programadores utilizam MySQL/MariaDB e não testam outras bases de dados, que em consequência têm falhas constantes. É portanto aconselhado que utilize MySQL/MariaDB quando testar correções, a menos que esteja especificamente a tentar melhorar o suporte de outra base de dados. Neste último caso, certifique-se de que não estraga MySQL/MariaDB (ou escreve consultas horrivelmente ineficientes nesta base de dados), pois MySQL/MariaDB é o que todas as outras pessoas usam.

JavaScript e CSS
O JavaScript e CSS tornaram-se omnipresentes no código do lado dos clientes. Não tem de conhecer JavaScript, jQuery e CSS para trabalhar no MediaWiki, mas poderá ser necessário, dependendo daquilo em que escolher trabalhar.


 * Aprenda JavaScript e CSS
 * JavaScript and CSS at Wikibooks.
 * Iniciar-se em jQuery — Um guia prático de jQuery.
 * Learning JavaScript — references and sources.


 * Recursos de JavaScript e CSS
 * Convenções de código JavaScript na comunidade MediaWiki.
 * Convenções de código CSS na comunidade MediaWiki.

MediaWiki
O código do MediaWiki é extenso e algumas partes são feias; não se intimide. Quando está a começar, foque-se em criar funcionalidades ou corrigir defeitos que tocam apenas numa pequena região do código.


 * Leituras de base e obrigatórias do MediaWiki:
 *  — Um perspetiva de alto-nível dos componentes principais do MediaWiki e de como estes funcionam uns com os outros.
 *  — Uma perspetiva de como e porquê escrever código seguro.


 * Recursos do MediaWiki:
 * — Uma lista de ficheiros importantes e hiperligações para informações mais detalhadas.
 * — Uma lista de hooks (ganchos). Se está a tentar determinar que parte do código faz determinada coisa, um bom sítio para começar é procurar os hooks relacionados com ela.
 * — Uma perspetiva geral de convenções de código na comunidade MediaWiki.


 * Documentação do código (referência de classes) — Documentação gerada automaticamente a partir do código e dos comentários do código.
 * — Um guia para despistar defeitos do MediaWiki.
 * — Uma ferramenta para interagir ao vivo com objetos do MediaWiki.

Extensões do MediaWiki
Se escolher trabalhar no código das extensões do MediaWiki, as seguintes hiperligações fornecem mais informações.


 * Princípios básicos das extensões do MediaWiki:
 * Desenvolver extensões — Como escrever uma extensão para o MediaWiki.
 * Guia prático de criação de extensões


 * Recursos sobre extensões do MediaWiki:
 * Melhoras práticas para extensões
 * Uma introdução breve ao desenvolvimento de extensões do MediaWiki — Uma apresentação em vídeo sobre como criar uma extensão do MediaWiki (slides).
 * Criar uma extensão do MediaWiki — Cobre como desenvolver uma extensão para o MediaWiki, melhores práticas, e como se integrar na comunidade MediaWiki. Desde fevereiro de 2011.
 * Ajuda para programadores de extensões no Portal de Desenvolvimento

Ver também

 * Search for code across repositories
 * – Quando tiver lido toda a informação descrita neste artigo, será altura de passar à informação no portal dos programadores.
 * – um conjunto de páginas relacionadas