Novos desenvolvedores

From mediawiki.org
This page is a translated version of the page New Developers and the translation is 67% complete.
Outdated translations are marked like this.

This page explains how to get started as a developer who wants to contribute to Wikimedia technical projects.

Bem-vindo!

Participants de Wikimedia Hackathon 2019

A comunidade técnica da Wikimedia sempre dá as boas-vindas a novos contribuidores para nossos projetos.

Torne-se parte de uma comunidade global e ajude a tornar o acesso ao conhecimento gratuito mais fácil para todos!

How to start contributing

The following steps are a general outline of how to get started contributing:

  1. Learn the basics of how Wikimedia open source software projects work.
  2. Read the Communication guidelines.
  3. Set up accounts: Create a developer account. Depending on the type of contribution you want to make, you may also need to set up accounts in Phabricator, and set up Git and Gerrit.
  4. Escolha um projeto de software
  5. Escolher e resolver uma tarefa (escreva e teste seu código)
  1. Enviar suas alterações de código

Follow the Guide to getting your code reviewed and submit a patch.

The rest of this guide provides additional details about the process.

Basics of how Wikimedia software projects work

A Wikimedia possui centenas de projetos de software em diversas áreas. Confira esses slides se você deseja obter uma visão geral.

Os mantenedores de cada projeto de software são livres para escolher a infraestrutura que preferem. Em geral, basicamente todos os projetos de software têm

  • uma ferramenta de rastreamento de tarefas onde bugs de software e solicitações de melhorias são relatados, gerenciados e discutidos. Os exemplos são Wikimedia Phabricator, GitHub ou Sourceforge.
  • um repositório de código onde o código-fonte pode ser "verificado" para todos. Os exemplos são Wikimedia Git/Gerrit, GitHub ou Sourceforge.
  • a code review tool where proposed code changes ("patches") get discussed and improved. Examples are Wikimedia Git/Gerrit, GitHub, or GitLab. After your proposed patch is approved and merged into the code repository, your code changes become available to everybody.
  • locais gerais para discussão do projeto de software e/ou para receber ajuda e suporte. Esses lugares podem ser listas de e-mail ou canais de bate-papo IRC ou páginas wiki ou outros lugares. Os locais exatos dependem de cada projeto. Você também pode entrar em contato com mentores específicos por meio de "$1" em suas páginas de usuário, mas observe que "perguntas feitas em particular não ajudam os outros".

A qualquer momento, se você tiver problemas ou precisar de ajuda, pergunte. Se você quiser fazer boas perguntas nos lugares certos, recomendamos que você leia a seção "Comentários, perguntas e suporte".

Escolha um projeto de software

The following projects offer resources, mentorship, and are looking for new developers to contribute to them. Esta é a maneira recomendada de começar. Escolha um dos seguintes projetos e siga a documentação do projeto para configurar seu ambiente de desenvolvimento, escolha uma tarefa para trabalhar, resolva a tarefa e envie suas alterações de código para revisão: You are free to contribute to these projects or any others you are interested in related to Wikimedia. Most can be found by searching for them on Phabricator or online.

Kiwix

Screenshot

An offline reader for people without internet access

Aplicativo Commons para Android

Screenshot

Um aplicativo para dispositivos Android para carregar suas fotos no Wikimedia Commons

Painel de Educação da Wiki

Screenshot

Um aplicativo da Web que suporta tarefas de educação da Wikipedia, fornece gerenciamento de dados e curso para instrutores e alunos

Logo Pywikibot

Terminal

Uma biblioteca Python e coleção de scripts que 'automatizam o trabalho' nos sites do MediaWiki.

Scribe

Scribe features

Scribe provides Wikidata based keyboards for second language learners. Features include translation, verb conjugation and noun-gender annotation. This project is very open to those who want to learn the needed languages and how to work with Wikidata!

Logo VideoCutTool

VideoCutTool

Uma ferramenta para editar os vídeos do Wikimedia Commons.

Você é um mantenedor e deseja que seu projeto seja incluído na lista de projetos de software acima? Saiba mais e participe!

Programas de extensão e tarefas únicas

Além dos projetos de software recomendados acima, há mais maneiras de escolher um projeto ou tarefa para trabalhar:

Logo Programas de extensão

A Wikimedia oferece estágios em programas como Google Summer of Code e Outreachy.

Logo Boas primeiras tarefas

Existem muitas tarefas únicas (em muitos projetos de software) que são adequadas para iniciantes.
No entanto, você está mais por sua conta aqui: Não podemos garantir que os mentores estejam disponíveis ou que os patches propostos receberão análises rápidas.

Algumas dicas gerais de comunicação

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:

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.

Procurando recursos adicionais?

  • Como contribuir lista muitas outras maneiras de contribuir, também em áreas não técnicas como documentação, testes, API da web e muito mais.
  • Hub do desenvolvedor: Recursos para obter mais documentação e informações para desenvolvedores estabelecidos da Wikimedia.
  • To ask your questions and to join general discussions, check the places listed on Communication.
  • Tutoriais da Wikimedia: Um índice de tutoriais que apresentam várias linguagens, APIs e estruturas na pilha de tecnologia da Wikimedia.