wiki

Руководство по работе с osu! wiki

Спасибо за интерес, проявленный к osu! wiki. В этой статье вы найдёте подробное описание того, как редактировать вики. Если вы знакомы с GitHub, пользуйтесь схемой «одна статья (или группа статей на одну тематику) — одна ветка», а потом сразу переходите к разделу «Самопроверка».

От новых редакторов не ожидается знание GitHub или git, так как эти инструменты в основном применяются разработчиками. Если что-то пойдёт не так, не переживайте: кто-нибудь из администраторов osu! wiki либо поможет советом, либо самостоятельно исправит проблему.

Если вам в какой-то момент понадобится помощь, обращайтесь в дискорд-сервер osu!dev на канал #osu-wiki.

Чем можно помочь

Если у вас есть желание помочь, но нет понимания, с чем именно, загляните в раздел Работа над osu! wiki § Рутинные задачи. В ней описаны задачи, которые нуждаются в регулярном контроле, и прочие способы помочь. Если вы пытаетесь понять, как тут работает форматирование, посмотрите шпаргалку по Markdown.

Редактирование вики

О том, как в целом устроен процесс внесения правок в чужие репозитории, см. GitHub flow - GitHub Docs

Статьи osu! wiki хранятся на GitHub. Чтобы их отредактировать, нужно сделать следующее:

  1. Откройте репозиторий ppy/osu-wiki и нажмите на кнопку с подписью Fork, которая находится в правом верхнем углу. Так вы создадите копию osu! wiki, к которой будете иметь полный доступ. Чтобы по-быстрому перейти к копии, откройте ppy/osu-wiki и снова нажмите на кнопку Fork.
  1. Внимательно прочитайте раздел Как правильно работать с вики § Внесение правок и сделайте нужные изменения в форке (переведите статью, добавьте картинки и т.д.) – для этого можно пользоваться любыми доступными программами и инструментами. На osu! wiki есть инструкции к двум наиболее популярным из них:
  • Веб-редактор GitHub (браузерное приложение, не требует установки).
  • GitHub Desktop (обычное приложение, имеет больше возможностей).

Самопроверка

Потратьте несколько минут на то, чтобы проверить свои изменения по списку ниже:

  • Стиль письма: статьи osu! wiki, за редким исключением, должны быть написаны нейтрально.
  • Содержание и правописание: статьи должны быть написаны внятным и доходчивым языком, а также не вгонять читателя в ступор своими формулировками. Будьте последовательны при изложении мыслей и избегайте переусложнённых или обрывистых предложений: вы пишете для живых людей. По возможности пользуйтесь редакторами со встроенной проверкой орфографии и пунктуации, чтобы отлавливать ошибки и опечатки (например, Google Docs).
  • Равенство содержания: в переводах должна содержаться та же информация, что и в оригиналах (само собой, допускаются расхождения в формулировках или пунктуации). Если вам кажется, что в оригинальной статье не хватает чего-то важного, или она устарела, не пытайтесь улучшать перевод «на ходу» — заведите issue или отправьте пулл-реквест с оригинальными правками, если хватает времени или сил.
  • Структура и оформление: чтобы проверить форматирование, откройте статью в каком-нибудь редакторе, умеющем показывать превью, например, Markdown Editor от jbt.
  • Изображения и прочие бинарные файлы должны «весить» меньше одного мегабайта. Скриншоты нужно делать с выбранным стандартным скином и некоторыми настройками, например, в разрешении 1280×720.

Полный список правил есть в критериях оформления статей. Критерии не нужно заучивать; достаточно бегло их просмотреть, а на упущенные ошибки вам укажут при ревью.

Пулл-реквест

Если вы перепроверили свою работу, закоммитили и запушили все правки, их теперь нужно показать администраторам osu! wiki. Это делается с помощью отправки пулл-реквеста:

  1. Откройте ваш форк osu! wiki, найдите кнопку с надписью master↓ и выберите там ветку с нужными изменениями.
  2. Нажмите на кнопку Contribute↓ и выберите пункт Open pull request.
  3. Прочитайте Как правильно работать с вики § Как отправить пулл-реквест и заполните текстовое поле. После этого нажмите на кнопку Create pull request.

Ревью

Все правки проверяются. На практике это означает, что другие люди будут читать ваш пулл-реквест, искать в нём ошибки и описывать или напрямую предлагать варианты исправлений. Во время ревью, как это везде принято, необходимо реагировать на замечания: их нужно либо исправлять, либо объяснять, почему вы не хотите так поступать.

Если к вам никто не заглянул, а время идёт, попробуйте что-нибудь сделать:

  • Убедитесь, что вы разобрались со всеми замечаниями. Возможно, кто-то из текущих или будущих ревьюеров ждёт именно этого.
  • Загляните на канал #osu-wiki в дискорд-сервере osu!dev и попросите там о ревью, либо оставьте комментарий к своему пулл-реквесту.
  • Чтобы понять, у кого искать помощи с русским языком, посмотрите чужие переводы и свяжитесь либо с их авторами, либо с ревьюерами (ссылка для поиска русских переводов на GitHub).
  • Если у вас есть друзья, хорошо знающие язык или разбирающиеся в предмете, обратитесь к ним!

Помимо процесса ревью, в репозитории osu! wiki есть автоматические проверки, контролирующие оформление статей. Чтобы посмотреть, как они отработали, откройте пулл-реквест и перейдите на вкладку Actions – если там есть ошибки, в них будет написано, что и где именно нужно исправить.

Публикация

Рано или поздно ваш пулл-реквест проверит один из администраторов вики – обычно это происходит после ревью от других людей. Если ничего не происходит в течение нескольких дней, позовите администраторов в комментариях к пулл-реквесту, либо на канале #osu-wiki в дискорд-сервере osu!dev. После того, как вашу ветку вольют в master, соответствующие статьи обновятся (чаще всего это происходит за пару секунд, в худшем случае – в течение пяти часов).