Новые разработчики
Эта страница объясняет, как начать работу в качестве разработчика, который хочет внести свой вклад в технические проекты Викимедиа.
Добро пожаловать!
В техническом обществе Викимедиа всегда рады новым участникам!
Станьте частью мирового сообщества и помогите облегчить доступ к свободным знаниям для всех!
Как внести свой вклад: первые шаги
Следующие шаги представляют собой общую схему того, как начать вносить свой вклад:
- Изучите основы работы проектов с открытым исходным кодом Викимедиа.
- Прочитайте Руководство по коммуникации.
- Приготовьте аккаунты: Создайте аккаунт разработчика. В зависимости от вида вклада, который вы хотите сделать, вам также может понадобиться создать аккаунты в Фабрикаторе и Git и Gerrit.
- Выберите проект программного обеспечения.
- Выберете и выполните задачу (то есть напишите и протестируйте ваш код).
- Отправьте изменения в коде на проверку. Следуйте Руководству по получению проверки вашего кода и отправке патча.
Остальная часть данного руководства содержит дополнительные сведения об этом процессе.
Основы работы программных проектов Викимедиа
У Викимедиа есть программные проекты во многих областей.
Сопровождающие в каждом проекте программного обеспечения сами выбирают предпочтительную для них инфраструктуру. В целом, большинство программных проектов имеют:
- инструмент отслеживания задач, в котором сообщают, обрабатываются и обсуждаются ошибки программного обеспечения и запросы на улучшения. Примеры: Фабрикатор Викимедиа, GitHub или GitLab Викимедиа.
- репозиторий кода, где исходный код может быть «проверен» всеми. Примеры: Git/Gerrit Викимедиа, GitHub или GitLab Викимедиа.
- инструмент проверки кода, в котором обсуждаются и улучшаются предлагаемые изменения кода («патчи»). Примеры: Git/Gerrit Викимедиа, GitHub или GitLab. Как только предложенный вами патч будет одобрен и добавлен в репозиторий кода, ваши изменения кода станут доступны всем.
- Основные места для обсуждения проектов програмного обеспечения, для помощи и поддержки. Этими местами могут быть списки рассылки, каналы чата IRC, вики-страницы или другие места. Точные места зависят от каждого проекта.
Если у вас возникнут проблемы или вам понадобится помощь, обращайтесь, пожалуйста, в любой момент времени. Чтобы задавать дельные вопросы в правильных местах, обратитесь к «советам по коммуникации».
Overview of technical areas
For an overview of Wikimedia technology and examples of the major areas where developers can contribute, visit Introduction to the Wikimedia Technical Ecosystem.
Contributing to software in MediaWiki
Are you a user of a MediaWiki wiki looking to add a feature or fix a bug in one? Please see Как стать MediaWiki хакером to learn how to find and contribute to the software project part of MediaWiki you are looking for.
Выберите программный проект
Следующие проекты предлагают ресурсы, наставничество и ищут новых разработчиков для участия в них. Выберите один из следующих проектов и следуйте документации проекта, чтобы настроить среду разработки, выбрать задачу для работы, выполнить её и отправить изменения кода на рассмотрение. Вы можете внести свой вклад в эти проекты или любые другие, интересные вам, которые связаны с Викимедиа. Большинство из них можно найти, если поискать на Фабрикатор или в интернете.
Оффлайн-ридер для людей, не имеющих доступа в интернет
- Необходимые навыки: Java/Kotlin (Android), Swift (iOS), Qt (desktop), NodeJS (mediawiki offliner), C++, Python (WP1)
- Связаться с нами: Mailing list / Слак
- Получить исходный код: GitHub
- Прочтите общую документацию и файл README.md соответствующего проекта.
- Проверить рекомендуемые задачи для выполнения: Android, iOS, JS, mwoffliner on GitHub
- Наставник(и): Matthieu Gauthier, Emmanuel Engelhart, Stephane Coillet-Matillon
Приложение «Викисклад» для Android
Приложение для Android-устройств создано для загрузки изображений на Викисклад.
- Необходимые навыки: Java
- Связаться с нами: Google Groups
- Получить исходный код: GitHub
- Прочитать документацию
- Проверить рекомендуемые задачи для выполнения: GitHub
- Наставник(и): Josephine Lim
Wiki Education Dashboard
Веб-приложение, поддерживающее образовательные задания Википедии, предоставляющее данные и управление курсами для преподавателей и студентов.
- Необходимые навыки: Ruby, JavaScript
- Связаться с нами: #wikimedia-ed подключиться на irc.libera.chat
- Получить исходный код: GitHub
- Прочитать документацию
- Проверить рекомендуемые задачи для выполнения: GitHub
- Наставник(и): Sage Ross
Pywikibot
Библиотека Python и набор скриптов, которые автоматизируют работу в MediaWiki.
- Необходимые навыки: Python
- Связаться с нами: #pywikibot подключиться on irc.libera.chat / Mailing list
- Получить исходный код: Используйте Git для получения исходного кода
- Прочитать документацию и [$url справку по API]
- Проверить рекомендуемые задачи для выполнения: Phabricator
- Наставник(и): xqt
Scribe
Scribe предоставляет клавиатуры на основе Викиданных для изучающих иностранный язык. Функциональность: перевод, спряжение глаголов и аннотация существительных по роду. Этот проект очень открыт для тех, кто хочет учить необходимые им языки и научиться работать с Викиданными!
- Необходимые навыки: Swift для iOS; Kotlin для Android; Python и/или Сервис запросов Викиданных для запросов и форматирования Викиданных
- Связаться с нами: через GitHub или по эл. почте
- Получить исходный код: GitHub
- Прочитать руководства для участников: по iOS или Android
- Проверить рекомендуемые задачи для выполнения: iOS или Android
- Наставник(и): Andrew McAllister
VideoCutTool
Инструмент для редактирования видео на Викискладе.
- Необходимые навыки: React JS, Node JS.
- Связаться с нами: #VideoCutTool in Zulip
- Получить исходный код: See link in description in Phabricator
- Прочитать документацию
- Проверить рекомендуемые задачи для выполнения: Phabricator
- Наставник(и): Gopa Vasanth
SignIt Firefox Extension
Lingua Libre SignIt web-browser extension translates selected written word via an elegant pop up so you learn sign language while reading online. You can add a signed video using Lingualibre.org by selecting a signed language, then video recording yourself while signing.
- Skills required : JS, web extension, OOjs
- Get in touch: contact Yug or on GitHub
- Get the source code: GitHub
- Read the documentation: m:Lingua Libre/SignIt
- Check the recommended tasks to work on: Good first issues on GitHub »
- Mentor(s): Yug
Сопровождаете проект и хотите, чтобы он был включен в список программных проектов выше? Узнайте подробности и присоединяйтесь!
Рекламные программы и отдельные задачи
Помимо рекомендованных выше программных проектов, есть еще несколько способов выбрать проект или задачу для работы:
Рекламные программы
Хорошие задачи для новичков
Однако, наставников для этих задач может не быть, а предложенные вами патчи могут не получить быстрых проверок.
Советы по коммуникации
Follow these tips to communicate effectively and get help from community members.
Use Phabricator tasks effectively
When you plan to work on a Фабрикатор 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
- 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 Общение .
- 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.
Дополнительные ресурсы
- Introduction to the Wikimedia Technical Ecosystem provides an overview of Wikimedia tech, focused on the major areas where developers can contribute.
- В списке Как внести свой вклад есть множество других способов как внести свой вклад, включая различные области вроде документации, тестирования и многого другого.
- Как стать хакером MediaWiki: для разработчиков, которые хотят работать с ядром MediaWiki или расширениями MediaWiki.
- Newbie guide for the Web team
- Центр разработчиков: Больше ресурсов для опытных разработчиков Викимедиа.
- Чтобы задать свои вопросы и присоединиться к общим дискуссиям, загляните в места, указанные в разделе Общение.
- Руководства Викимедиа: указатель руководств, в которых представлено множество языков, различные API и фреймворки в стеке технологий Викимедиа.
- Supporting newcomers at hackathons
- Newcomer support at hackathons and the associated mentor guide
- Newcomers section of the Hackathons Handbook, as well as the Mentoring Tips page
- How-to page for newcomers at the Wikimedia Hackathon 2022