Como se tornar num hacker do MediaWiki

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page How to become a MediaWiki hacker and the translation is 100% complete.

Other languages:
العربية • ‎български • ‎বাংলা • ‎dansk • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎magyar • ‎interlingua • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Nederlands • ‎occitan • ‎ਪੰਜਾਬੀ • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎српски / srpski • ‎svenska • ‎ไทย • ‎Türkçe • ‎Tiếng Việt • ‎中文

Este artigo foi escrito para ajudar os programadores a adquirirem os conhecimentos de base necessários para contribuírem para o desenvolvimento do MediaWiki central 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 o Developer hubDeveloper hub.

Para outras formas de se envolver na comunidade Wikimedia, consulte Como contribuirHow to contribute.

Perspetiva geral

O MediaWiki é o software da Wikipédia, dos projetos relacionados com ela e de milhares de wikis em todo o mundo.

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

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

O desenvolvimento é feito com código aberto[4], é coordenado em grande medida online, e é suportado pela Wikimedia Foundation, 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.

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: 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

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

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 PhabricatorPhabricator).


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 sobre a infraestrutura (Git, Gerrit, Vagrant), a arquitetura do software ou fluxos de trabalho que não estão ligados à tarefa específica em que quer trabalhar, use canais genéricos como IRCIRC, listas de divulgação ou páginas de discussão e não a tarefa específica. 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 (que normalmente é uma tarefa no PhabricatorPhabricator). 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 ComunicaçãoCommunication.
  • 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.


Apêndice

Colaboradores do 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 de PHP
Coisas a saber
  • O script maintenance/eval.php no MediaWiki fornece um interpretador básico de PHP com objetos e classes MediaWiki carregados.

Base de dados

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

Aprender MySQL/MariaDB
Recursos de MySQL/MariaDB.
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
Recursos de JavaScript e CSS

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
Recursos 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
Recursos sobre extensões do MediaWiki

Ver também

  1. Nem todo o MediaWiki está em PHP. Algumas ferramentas de apoio estão escritas noutras línguas, incluindo ficheiros batch, shell scripts, makefiles e Python.
  2. O MediaWiki corre na maioria das plataformas que suportam o PHP. No entanto, a falta de certos utilitários ou funcionalidades do sistema operativo pode limitar a funcionalidade ou o desempenho do MediaWiki em plataformas que não sejam LAMP.
  3. O MediaWiki suporta outras DBMS além de MySQL e MariaDB, incluindo Oracle, PostgreSQL, SQLite e Microsoft SQL Server.
  4. Os programadores são uma mistura de voluntários e pessoal assalariado (ou contratados) para várias organizações. Para uma lista completa de quem trabalha no código do MediaWiki, leia o artigo DevelopersDevelopers.
  5. Visite os repositórios do código-fonte e respetivas revisões de código em https://phabricator.wikimedia.org/diffusion/ ou descarregue o código-fonte para o seu sistema usando o Gerrit.