Новые разработчики

From mediawiki.org
This page is a translated version of the page New Developers and the translation is 71% 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.

Добро пожаловать!

Участники Wikimedia Hackathon 2019

В техническом обществе Викимедия всегда рады новым участникам!

Станьте частью мирового сообщества и помогите сделать доступ к свободным знаниям легче для каждого!

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. Выберите программный проект
  5. Выберете и решите задание (напишите и протестируйте ваш код)
  6. Отправьте свои изменения в коде на проверку. 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

У Викимедиа есть программные проекты в многих областей.

Сопровождающие каждого программного проекта могут свободно выбирать инфраструктуру, которую они предпочитают. В общем, практически все программные проекты имеют

  • инструмент отслеживания задач, в котором сообщаются, обрабатываются и обсуждаются ошибки программного обеспечения и запросы на улучшения. Примеры: Фабрикатор Викимедиа, GitHub или Sourceforge.
  • репозиторий кода, где исходный код может быть «проверен» всеми. Примеры: Викимедиа Git / Gerrit, GitHub или Sourceforge.
  • инструмент проверки кода, в котором обсуждаются и улучшаются предлагаемые изменения кода (так называемые «патчи»). Примеры: Викимедиа Git / Gerrit, GitHub или Sourceforge. Как только предложенный вами патч будет исправен и будет добавлен в репозиторий кода, ваши изменения кода станут доступны всем. (Вы можете узнать больше о передовых методах проверки кода здесь.)
  • Основные места для обсуждения программных проектов и/или получения помощи и поддержки. Этими местами могут быть списки рассылки, каналы чата IRC, вики-страницы или другие места. Точные места зависят от каждого проекта. Вы также можете связаться с конкретными наставниками через "Отправить этому пользователю электронное письмо" на их пользовательских страницах, но учтите, что «вопросы, заданные лично, не помогают другим».

В любой момент, если у вас возникнут проблемы или вам понадобится помощь - пожалуйста, спрашивайте. Если вы хотите задавать хорошие вопросы в нужных местах, мы рекомендуем вам прочитать раздел «Отзывы, вопросы и поддержка».

Выберите программный проект

The following projects offer resources, mentorship, and are looking for new developers to contribute to them. Это рекомендуемые способы начать. Выберите один из следующих проектов и следуйте документации проекта, чтобы настроить среду разработки, выбрать задачу для работы, решить задачу и отправить изменения кода на рассмотрение: 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 Фабрикатор or online.

Kiwix

Screenshot

An offline reader for people without internet access

Commons App for Android

Screenshot

Приложение для устройств Android, позволяющее загружать изображения на Wikimedia Commons.

Wiki Education Dashboard

Screenshot

Веб-приложение, поддерживающее образовательные задания Википедии, предоставляющее данные и управление курсами для преподавателей и студентов.

  • Требуемые навыки: Ruby, JavaScript
  • Связаться с нами: #wikimedia-ed connect и irc.libera.chat
  • Получить исходный код: GitHub
  • Прочитать документацию
  • Проверить рекомендованные задачи над которыми можно поработать GitHub
  • Наставник(и): Sage Ross

Logo Pywikibot

Terminal

Библиотека Python и набор скриптов, которые «автоматизируют работу» на сайтах 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

Инструмент для редактирования видео на Wikimedia Commons

"Вы сопровождаете и хотите, чтобы ваш проект был включен в список программных проектов выше? Узнай больше и присоединяйся!"

Рекламные программы и отдельные задачи

Помимо рекомендованных выше программных проектов, есть еще несколько способов выбрать проект или задачу для работы:

Logo Рекламные программы

Викимедиа предлагает стажировки в таких программах, как Google Summer of Code и Outreachy.

Logo Хорошие первые задания

Есть много отдельных задач (по многим программным проектам), которые подходят для новичков.
Однако вы здесь больше сами по себе: мы не можем гарантировать, что наставники доступны или что предложенные вами патчи получат быструю проверку.

Советы по коммуникации

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 Фабрикатор 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 Общение .
    • 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.

Дополнительные ресурсы

  • В списке Как внести свой вклад есть множество других способов как внести свой вклад, в том числе и в нетехнических областях.
  • Как стать хакером MediaWiki: для потенциальных новых разработчиков, которые хотят работать напрямую с ядром MediaWiki или расширениями MediaWiki.
  • Центр разработчиков: ресурсы с дополнительной документацией и информацией для опытных разработчиков Викимедиа.
  • To ask your questions and to join general discussions, check the places listed on Communication.
  • Туториалы Викимедиа: указатель учебных пособий, в которых представлены различные языки, API и фреймворки в стеке технологий Викимедиа.