How to become a MediaWiki hacker/pt

Este artigo está escrito para ajudar programadores a adquirirem as capacidades necessárias para contribuir para o desenvolvimento do MediaWiki.

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

Perspetiva geral
O MediaWiki é o software da Wikipédia, os projetos relacionados com ela, e milhares de wikis em todo o mundo. Pode ser executado na maioria dos sistemas operativos, está escrito em PHP, usa sobretudo os servidores de base de dados MySQL e MariaDB, e usa o jQuery como biblioteca de JavaScript do cliente. O desenvolvimento do MediaWiki é apoiado principalmente pela Wikimedia Foundation, embora programadores voluntários da comunidade desempenhem também um papel muito importante.

Esta página pode ajudá-lo a iniciar o caminho para se tornar 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.

Começar
Comece por se registar para  e ler o Guia Prático do Gerrit. Depois pode passar à frente e descarregar o nosso código, fazer alterações, testá-las e enviar modificações. Há duas formas de configurar o ambiente de desenvolvimento: usando o instalador de uma máquina virtual pré-configurada (vagrant), ou manualmente.

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)

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).
 * — Descarregue o último código fonte 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


Recomendações gerais
Se escolher trabalhar num relatório de defeito que requira escrever ou alterar código, deve no mínimo ler por alto estas páginas antes:

 
 * Os dois caminhos principais para se iniciar no desenvolvimento do MediaWiki são corrigir um defeito pequeno mas irritante no código existente, ou adicionar uma funcionalidade nova, geralmente através de uma extensão do MediaWiki.
 * Convenções de código e quaisquer subpáginas relevantes para a sua tarefa (,, ,...)
 * Seguindo as diretrizes para mensagens de integração de código, especialmente a secção Exemplo abaixo, adicionará automaticamente uma notificação sobre a sua alteração ao relatório correspondente no . Deixou de existir a necessidade de adicionar o comentário "Please review" no relatório.
 * Verifique o seu código contra a lista de pré-integração de código. Não salte este passo ; ficará feliz por não o ter feito.
 * Obter revisões de código. Procure e adicione pessoas como possíveis revisores das suas alterações.
 * Emendar uma alteração. Não crie uma nova alteração no Gerrit para corrigir uma alteração sua anterior!
 * Na maioria dos casos em que estiver a trabalhar no MediaWiki, não quer mexer no núcleo central do MediaWiki a menos que saiba verdadeiramente o que está a fazer.

Comentários, perguntas e assistência
 
 * É 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 sobre a infraestrutura, a arquitectura do software ou fluxos de trabalho que não estão ligados ao defeito específico em que quer trabalhar, use canais genéricos como, listas de divulgação ou páginas de discussão. Por exemplo, se tem um problema com o Gerrit, a página de discussão do Gerrit poderá ser um bom lugar para perguntar.
 * Se tiver dúvidas específicas acerca do defeito, comente no relatório correspondente no . O que devo fazer para 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 responder 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. Tente ser 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 e-mails privados ou assistência a questões em nossos canais da mídia social.
 * Por favor seja paciente quando estiver a busca de entrada e comentários. No IRC, não pergunte em perguntas, apenas pergunte: a maioria das questões podem ser respondidas por outras comunidades membros igualmente, se você perguntar em um canal IRC. Se ninguém responde, por favor faça a pergunta na página de relato de erros relacionadas com o problema; não desista simplesmente da pergunta.
 * Aprenda mais em.
 * You can ask at the weekly Technical Advice IRC Meeting on #wikimedia-tech

Comunique que está a trabalhar na correção de um defeito
Não é preciso perguntar se pode trabalhar num defeito. Não é preciso estar atribuído como responsável por um relato de erros nem anunciar os seus planos antes de começar a corrigir um defeito, mas seria bom se o fizesse. O mais tardar quando estiver prestes a enviar uma correção para o defeito, é bom anunciar num comentário que está a trabalhar nesse defeito. O seu anúncio também ajuda os outros a não trabalharem na correção do mesmo defeito e desperdiçar esforço.

Note também que se o relato do defeito já tem uma ligação recente com a correção do erro no Gerrit e tem associado o projeto "Patch-For-Review", deve escolher um defeito diferente para corrigir - evite trabalho em duplicado. Se a correção 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.

Se parar de trabalhar numa tarefa, deve remover-se como responsável pelo relatório de defeito e restaurar o responsável para o estado pré-definido, de modo que os restantes saibam que podem trabalhar na correção desse defeito e não julguem que você o está a fazer.

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

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


 * Iniciação nas extensões do MediaWiki:
 * Desenvolver extensões — Como escrever uma extensão para o MediaWiki.
 * Escrever extensões para lançamento — Se pretender ter a sua extensão lançada nos sites da Wikimedia (incluindo possivelmente a Wikipédia), é necessário um escrutínio adicional em termos de desempenho e segurança.
 * Guia prático de criação de extensões


 * Recursos de extensões do MediaWiki:
 * Melhoras práticas para extensões
 * Lista de extensões simples — Uma forma simples de se familiarizar com a forma como as extensões funcionam.
 * 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.
 * Modelo de páginas especiais — Adicione uma página especial para mostrar informações úteis.
 * Expandir a notação wiki — Adicione um hook ao analisador sintático para modificar o conteúdo do texto wiki.

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 a saber:
 * O script  no MediaWiki fornece um interpretador básico de PHP com objetos e classes MediaWiki carregados.

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.


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


 * 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 restritos a pequenas regiões do código.


 * Iniciações e leituras obrigatórias do MediaWiki:
 * Arquitetura 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 MediaWiki:
 * — Uma lista importante de ficheiros 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.
 * — Formas de alterar o MediaWiki, desde as preferências do utilizador, às extensões e ao código base.
 * Documentação do código — 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.

Ver também

 * – Se já leu toda a informação descrita neste artigo, é tempo de passar à informação no portal dos programadores.
 * MediaWiki Virtual Library (MVL) books; this page forms also part of the MediaWiki Developers Guide.
 * – Se já leu toda a informação descrita neste artigo, é tempo de passar à informação no portal dos programadores.
 * MediaWiki Virtual Library (MVL) books; this page forms also part of the MediaWiki Developers Guide.