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 a utilização 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 deverá ajudá-lo a tornar-se em um colaborador do MediaWiki. Esta não é um tutorial; indica-lhe apenas os vários locais onde poderá aprender o que é 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 erros e as tarefas relacionadas são geridas no Phabricator.

Configurar o seu ambiente de desenvolvimento
A maioria dos projetos utilizam o Git e o Gerrit. Siga o tutorial do Gerrit para configurar a sua conta de desenvolvimento. Depois poderá transferir o nosso código, efetuar alterações, testá-las e submeter as correçõ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 do 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).


 * — Transferir o código fonte mais recente do Git.
 * — Continue 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 transferir as cópias de ficheiro da base de dados da Wikipédia para desenvolver as 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 [$discourse Apoio aos Programadores da Wikimedia], MediaWiki on 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.
 * Do not ask if you can work on a task.
 * 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, pergunte; a maioria das perguntas 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.

Comunique que está a trabalhar numa tarefa
Não pergunte se poder trabalhar numa tarefa. Não é preciso anunciar os seus planos antes de começar a corrigir um erro, 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.


 * Aprender PHP
 * Tutorial de PHP — Disponível em muitos idiomas 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 muitos idiomas 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
 * Tutorial 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 muitos idiomas diferentes.
 * Base de Conhecimentos de MariaDB.
 * Convenções para código de base de dados na comunidade do MediaWiki.


 * Coisas a saber:
 * Teste o seu código com MySQL/MariaDB.
 * O MediaWiki atualmente utiliza o MySQL e MariaDB como o servidor principal da base de dados. Este também suporta outros 'Sistemas de Gestão da Base de Dados' (DBMSes), tais 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 estar familiarizado com JavaScript, jQuery e CSS para trabalhar no MediaWiki, mas poderá ser necessário, dependendo daquilo em que escolher trabalhar.


 * Aprender JavaScript e CSS
 * JavaScript and CSS at Wikibooks.
 * Iniciar-se com jQuery — Tutorial de jQuery.
 * Learning JavaScript — references and sources.


 * Recursos de JavaScript e CSS
 * Convenções de código JavaScript na comunidade do MediaWiki.
 * Convenções de código CSS na comunidade do 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.


 * Noções básicas e leituras obrigatórias do MediaWiki:
 *  — Um resumo de alto nível dos componentes principais do MediaWiki e como estes funcionam uns com os outros.
 *  — Um resumo de como e o porquê em escrever código seguro.


 * Recursos do MediaWiki:
 * — Uma lista de ficheiros importantes e hiperligações para informação mais detalhada.
 * — Uma lista de hooks. Se está a tentar determinar que parte do código faz determinada coisa, um bom local para começar é procurar por hooks relacionados.
 * — Um resumo de convenções de código gerais na comunidade do 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.


 * Básicos das extensões do MediaWiki:
 * Desenvolver extensões — Como escrever uma extensão para o MediaWiki.
 * Tutorial de criação de extensões


 * Recursos de 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 — Desde como desenvolver uma extensão para o MediaWiki até ás melhores práticas, e como se integrar na comunidade do MediaWiki. Desde fevereiro de 2011.
 * Ajuda para programadores de extensões no 'Portal de Desenvolvimento'

Consulte também

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