Como se tornar um hacker do MediaWiki

Este artigo está escrito para ajudar os desenvolvedores a aprender as habilidades básicas necessárias para contribuir com desenvolvimento de MediaWiki core e extensões MediaWiki. Observe que, na maioria dos casos, quando você trabalha com o MediaWiki, você não quer cortar o núcleo do MediaWiki a menos que você realmente saiba o que está fazendo.

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 o portal dos programadores - Central do Desenvolvedor .

Para outras formas de se envolver na comunidade Wikimedia, veja Como contribuir .

Visão geral

MediaWiki é o software que alimenta a Wikipédia, seus projetos parceiros e milhares de outras wikis ao redor do mundo.

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

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

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

• A discussão de desenvolvimento ocorre em várias mailing lists e canais IRC. A principal lista de programadores é wikitech-l. Os principais canais de desenvolvimento são o #mediawiki e o #wikimedia-dev.
• O código-fonte é gerido usando o sistema de controlo de versões Git.
• As revisões do código são feitas no Gerrit . Siga este guia prático para configurar o Git e o Gerrit de forma a poder enviar modificações do código.
• Os relatórios de defeitos e as tarefas relacionadas são geridos no Phabricator.

Esta página deve ajudá-lo a tornar-se um colaborador da MediaWiki. Isto não é um tutorial e sim o direciona a vários locais onde poderá aprender o que for necessário.

Configure seu ambiente de desenvolvimento

A maioria dos projetos usa Git e Gerrit. Segue o tutorial Gerrit para configurar sua conta de desenvolvedor. Então, você pode avançar para baixar nosso código, fazer alterações, testá-los e enviar patches. 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 o 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 dos servidores LAMP, MAMP ou WAMP (Linux, Mac ou Windows, mais Apache, MySQL/MariaDB e PHP).
• Download do Git — Descarregue o último código fonte do Git.
• Guia de instalação — 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 recomendada

Play media

Assista a como um programador corrige um defeito numa extensão do MediaWiki, incluindo a investigação, o commit no git, conseguir a revisão e integração no código, e o encerramento do ticket no Bugzilla (agora substituído pelo Phabricator ).

Feedback, perguntas e suporte

• É 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 Phabricator ). 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, apenas pergunte; 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.
• Saiba mais em Comunicação .
• Você também pode fazer qualquer pergunta na Reunião semanal de aconselhamento técnico IRC no canal #wikimedia-tech no Freenode IRC.

Comunique que você trabalha em uma tarefa

Não pergunte se você pode trabalhar em uma tarefa. Você não precisa anunciar seus planos antes de começar a trabalhar em um bug, mas seria bem-vindo. É possível configurar-se como o cessionário em uma tarefa: use o menu suspenso 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 você parar de trabalhar em uma tarefa, remova-se como o responsável pela tarefa, para que outros saibam que podem trabalhar na tarefa e não esperam que você continue trabalhando nela.

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

Apêndice

Colaboradores MediaWiki a trabalhar em Bangalore, Índia.

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 PHP

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

Coisas para saber

• O script maintenance/eval.php no MediaWiki fornece um interpretador básico de PHP com objetos e classes MediaWiki carregados.
• Adicionalmente, o ficheiro de comandos maintenance/shell.php no MediaWiki substitui o maintenance/eval.php baseado em PsySH; consulte Manual:Shell.php.

Base de dados

Muitas características requerem alguma manipulação da base de dados, portanto precisará frequentemente de estar familiarizado com MySQL ou MariaDB.

Aprender MySQL/MariaDB

• Guia prático de MySQL — Do Manual de referência do MySQL 5.0.
• MySQL at Wikibooks.

Recursos MySQL/MariaDB.

• Manuais de referência de MySQL. — Disponível em muitas línguas diferentes.
• MariaDB Base de Conhecimento (Knowledge Base).
• Convenções para código de base de dados na comunidade MediaWiki.
• Accessing the database

Coisas para 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 Gestores de 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 a utilizar 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

JavaScript e CSS tornaram-se omnipresentes no código do lado do cliente. Não tem de estar familiarizado com JavaScript, jQuery e CSS para trabalhar no MediaWiki, mas precisará ser preciso, 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 você começa pela primeira vez, aponte para escrever recursos ou corrigir erros que toquem apenas uma pequena região de código.

MediaWiki básico e deve-lê

• Arquitetura do MediaWiki — Uma visão geral de alto nível dos principais componentes do MediaWiki e como eles funcionam um com o outro.
• Security for developers — Uma perspetiva de como e porquê escrever código seguro.

Recursos MediaWiki

• Manual:Code — Uma lista importante de arquivos e hiperligações para informações mais detalhadas.
• Manual:Ganchos — 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.
• Manual:Convenções de codificação — Uma perspetiva geral de convenções de código na comunidade MediaWiki.
• Documentação do código (referência de classe) — Documentação gerada automaticamente a partir do código e dos comentários do código.
• Manual:Como depurar — Um guia para despistar defeitos do MediaWiki.
• Manual:eval.php/pt-br — Uma ferramenta para interagir ao vivo com objetos do MediaWiki.

Extensões MediaWiki

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

Princípios básicos das extensões MediaWiki

• Desenvolver extensões — Como escrever uma extensão para o MediaWiki.
• Guia prático de criação de extensões

Recursos de extensões do MediaWiki

• Melhores práticas para extensões
• Uma introdução breve ao desenvolvimento de extensões MediaWiki — Um vídeo de apresentação acerca de como criar extensões MediaWiki (slides).
• Criar uma extensão do MediaWiki — Cobre como desenvolver uma extensão para o MediaWiki, melhores práticas, e como integrar-se 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
• Central do Desenvolvedor – Quando você lê atentamente as informações contidas neste artigo, é hora de seguir as informações no hub do desenvolvedor.
• Guia dos Programadores do MediaWiki – um conjunto de páginas relacionadas
• Código de Conduta