MediaWiki

Como se tornar um hacker do MediaWiki

This page is a translated version of the page How to become a MediaWiki hacker and the translation is 99% complete.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎interlingua • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎українська • ‎বাংলা • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어

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[1]. Usa jQuery como a biblioteca JavaScript cliente.

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

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 ).
  • Do your research first: When you decide to work on a task, you are expected to do some basic research yourself first: Look at the code, try to get some understanding what it is supposed to do, read related documentation, try to find the probable place(s) where you need to make code changes. For a general overview, please read the Basics to know.
    • In a Phabricator task, see the project tags in the side bar to find out which code repository a task is about.
  • Ask and discuss in the best place:
    • In Phabricator tasks, discuss only specific questions about the topic of that very Phabricator task. General technical questions (e.g. how to set up a development environment or problems with Gerrit) are off-topic in Phabricator tasks.
    • For general technical questions, ask the broader Wikimedia community and use generic channels like IRC chat or mailing lists. (If you take part in an outreach program, then you can also use Zulip's technical-support stream.)
    • If you take part in an outreach program, then Zulip is for discussing questions about the outreach programs themselves.
  • Ask good questions: "Can you give me more info?", "Please guide me", "Please tell me how to start" are not good comments to start with: The more specific your questions are, the more likely somebody can answer them quickly. If you have no idea at all how to fix the bug, maybe that bug is not (yet) for you – consider finding an easier one first.
  • Provide context: When asking, explain what you want to achieve, and what you have tried and found out already, so others can help at the right level. Be specific – for example, copy and paste your commands and their output (if not too long) instead of paraphrasing in your own words. This avoids misunderstandings.
  • Ask in public: Do not send private messages if your conversation topic is not secret. Private messages do not help others.
  • Be patient when seeking input and comments, especially during weekends and holidays.
    • On IRC, don't ask to ask, just ask: most questions can be answered by other community members too if you ask on an IRC channel. If nobody answers, please try again at a different time; don't just give up.
    • Do not ask people immediately for code review in a separate message. People receive Gerrit and Phabricator notifications.
  • Keep conversations readable: When you reply in Zulip, in Phabricator tasks, or on mailing lists, please avoid unneeded quoting of a complete previous comment. Provide sufficient context and keep threads readable.
  • Follow the code of conduct for Wikimedia technical spaces.
  • When you plan to work on a Phabricator task:
    • No need to ask for permission: Usually there is no reason to ask if you can work on something or if somebody could assign a task to you. There is no authority who assigns tasks or who needs to be asked first.
    • You do not need to announce your plans before you start working on a task but it would be welcome. At the latest when you are close to proposing a patch for a task, it is good to announce that you are working on it, so that others don't duplicate work: If nobody else is already assigned, set yourself as task assignee by using the Add Action… → Assign/Claim dropdown.
    • Tasks with existing patches:
      • If a task already has a recent patch in Gerrit, choose a different task to work on instead – avoid duplicating work.
      • If an existing patch in Gerrit has not been merged and has not seen any changes for a long time, you could also improve that existing patch, based on the feedback in Gerrit and in the task.
    • When your plans or interests change: If you don't work on a task anymore, please remove yourself as the assignee of the task, so others know that they can work on the task and don't expect you to still work on it.

By communicating clearly and early you get attention, feedback and help from community members.

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

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ê
Recursos 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
Recursos de 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 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 Desenvolvedores .
  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.
Retrieved from "https://www.mediawiki.org/w/index.php?title=How_to_become_a_MediaWiki_hacker/pt-br&oldid=4339953"