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 são gerenciadas em Phabricator e podem ser vistas aqui

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.

Ambiente de desenvolvimento Docker

• MediaWiki Docker Dev – Executar o MediaWiki usando Docker (pode ser usado em servidores Linux, Windows e macOS). This is the recommended method.

You can also try the experimental mwcli tool which provides basic orchestration functionality for MediaWiki docker containers.

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)

Vagrant is a powerful tool, but it is more complex and less robust than Docker, and significantly more resource-intensive. It is mainly aimed at developers who need to set up complex, flexible environments, e.g. for testing the interaction of multiple extensions.

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).
• Baixar do Git — * $download — Descarregue o último código fonte do Git.
• Guia de instalação — * $guide — 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.

Communication tips and guidelines

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

Follow these tips to communicate effectively and get help from community members.

Use Phabricator tasks effectively

When you plan to work on a Phabricator task:

• No need to ask for permission: You can work on unassigned tasks without asking someone to assign them to you. There is no authority who assigns tasks or who needs to be asked first.
  • If a task already has a recent patch in Gerrit, choose a different task to work on instead.
  • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could improve that existing patch, based on the feedback in Gerrit and in the task.
• Do your research: When you consider working on a task, do research before you start coding. Look at the code, try to understand what it is supposed to do, read related documentation, and try to find the places where you need to make code changes.
  • In a Phabricator task, use the project tags in the side bar to find the code repository for the task.
  • If you have no idea at all how to fix the bug, consider finding an easier one first.
• You do not need to announce your plans before you start working on a task, but you should communicate that you are working on the task.
  • When you start work, set yourself as task assignee by clicking Edit Task… in Phabricator, and set your Phabricator username in the Assigned To field. This communicates to others that you are working on it, so they don't duplicate work.
  • When your plans or interests change: If you are no longer working on a task, remove yourself as the assignee of the task. This tells others that they can work on the task, and they won't expect you to still work on it.
• Follow Phabricator etiquette.
  • In Phabricator tasks, discuss only specific questions about the topic of that task. Don't use Phabricator to ask general questions, like how to set up a development environment or how to fix problems with Gerrit.

Compose good questions

• Don't ask to ask...just ask!.
• Be specific and provide context: Instead of simply asking "Can you give me more info?", "Please guide me", or "Please tell me how to start", include the following information in your question:
  • What are you trying to achieve?
  • What have you already tried? Copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words.
  • What have you found out already during your research? Include links to code, documentation, or other resources you already consulted.
• Use specific titles and subject lines in your communication. "Proposal draft" or "Need help" is not specific.
• Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, only quote sections of previous comments that are relevant to your response. If you quote a complete previous comment, it makes threads hard to read.

Follow communication policies and best practices

Before you send or post your question:

• Read and follow the code of conduct for Wikimedia technical spaces.
• Use inclusive language : Instead of using terms that assume a gender identity (like "guys", "madam", or "sir") use the name of the person instead.

Ask in the right place

• Ask in public: Do not send private messages if your conversation topic is not secret. Private messages don't help others.
• Ask and discuss in the best place:
  • In Phabricator tasks, discuss only specific questions about the topic of that task.
  • Ask general technical questions, like how to set up a development environment or how to fix problems with Gerrit, in the places listed on Comunicação .
  • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.

Be patient

After you post your question:

• Do not ask people for code review in a separate message. People receive Gerrit and Phabricator notifications and will respond when they can.
• When seeking input and comments, especially during weekends and holidays, you may need to wait until business hours resume. On chat channels like IRC: if nobody answers, try again at a different time; don't just give up!
• If you don't get an answer even after waiting and being patient, consider if other Communication channels might be a better place to ask your question.

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 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.
• Acessando o Banco de Dados

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.
• Segurança para desenvolvedores — 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

• Pesquise código nos repositórios
• Central do desenvolvedor – Quando você lê atentamente as informações contidas neste artigo, é hora de seguir as informações no hub do desenvolvedor.
• Código de Conduta