Посібник по роботі з osu! wiki

Дякуємо за вашу зацікавленість в покращенні osu! wiki! У цій статті крок за кроком описано, як зробити ваш внесок. У випадку, якщо ви знайомі з GitHub, можете спокійно виконувати все за стандартами feature-branch workflow для пропонування змін, перейшовши відразу до секції самоперевірки.

Від нових учасників не очікують знання GitHub або git, оскільки ці інструменти в основному орієнтовані на розробників. Не хвилюйтеся, якщо ви щось не зрозумієте з першого разу — мейнтейнери wiki, вкажуть вам правильний напрямок, або виправлять щось за вас.

У випадку, якщо вам потрібні поради на будь-якому етапі, не бійтеся запитати про це у каналі #osu-wiki на osu! Discord сервері.

Сфери зацікавленості

Якщо ви бажаєте допомогти, але не знаєте з чого почати, перегляньте статтю Підтримка osu! wiki § Повсякденні справи, щоб побачити список завдань, які потрібно виконувати регулярно, а також способи як допомогти іншим редакторам. Щоб ознайомитися з мовою форматування, яка використовується на wiki, перегляньте статтю Адама Прітчарда — Шпаргалка по Маркдауну.

Редагування wiki

Для узагальненого процесу роботи, перегляньте GitHub flow - Github Docs

Статті osu! wiki зберігаються на GitHub. Щоб зробити свій внесок у розробку, виконайте наступні кроки:

0. Створіть акаунт GitHub.
1. Відкрийте репозиторій ppy/osu-wiki і натисніть Fork в правому верхньому куті, щоб зробити контрольовану копію wiki. Щоб повернутися до вашого форку, перейдіть до ppy/osu-wiki і натисніть Fork знову.

   • Якщо ви зробили форк давніше, синхронізуйте його відповідно до статі Найкращі практики § Синхронізація форку.
2. Прочитайте статтю Найкращі практики § Внесення змін і виконайте необхідні правки. Ви можете використовувати будь-який застосунок на ваш вибір, але osu! wiki має детальну інструкцію для двох середовищ:

   • GitHub веб-орієнтований редактор (онлайн, інсталяція не потрібна).
   • GitHub Desktop (оффлайн, надає більше контролю).

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

Коли ви завершите редагування, виділіть трішки часу для перевірки вашої роботи. Скористайтеся наступним чек-лістом:

• Тон подання: статті osu! wiki, окрім рідкісних виключень, повинні бути написані нейтральним регістром.
• Стиль і граматика: статті повинні бути зрозумілими і не потребувати від читача значних розумових зусиль. Будьте послідовними і уникайте надто складних та неочікуваних речень. Використовуйте редактори із вбудованою перевіркою орфографії, такі як Google Docs, щоб виявляти опечатки чи синтаксичні помилки.
• Паритет вмісту: переклади повинні мати таку саму інформацію, як і оригінальні статті (відмінності в пунктуації, словах, або форматі очевидно, очікувані). Замість зміни вмісту перекладу, вікдрийте нове питання, або додатковий пул реквест для оригіналу, якщо ви вважаєте його незавершенним, неточним, або застарілим.
• Структура та оформлення: для попереднього перегляду вашої статті використовуйте такі інструменти як jbt's Markdown Editor, щоб переконатися, що ваша стаття виглядає саме так як ви хотіли.
• Всі зображення та інші не текстові файли повинні бути менші 1 мегабайту. Знімки екрану повинні використовувати стандартний скін osu! і конкретні налаштування, а також мати максимальне співвідношення сторін 1280х720.

Для більш конкретних стандартів написання і оформлення, перегляньте сторінку критерії стилізації статті. Не варто читати її всю за раз, оскільки людина, яка буде оглядати вашу статтю, ймовірно вкаже чи потрібно щось виправити.

Пул реквест

Після того, як внесені зміни були добре перевірені, внесені і запушені до вашого форку, вам потрібно запропонувати їх для мейнтейнерів wiki відкривши пул реквест:

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

Огляд

Всі зміни, які вносяться до osu! wiki — модеруються. Під час цього етапу, інші учасники вказують на можливі помилки і шляхи їх вирішення у розмовній формі, або безпосередньо редагуванням вашого пул реквесту. Так само як і в будь-якому рецензуванні, вам потрібно адресувати коментарі використовуючи пропозиції, або пояснюючи чому ви би хотіли зробити по своєму.

Якщо ніхто не перевірив ваш пул реквест за декілька днів, спробуйте наступне:

• Переконайтеся, що ви розібралися з усіма пропозиціями — люди можуть чекати вашої відповіді.
• Запитайте інших редакторів osu! wiki на osu! Discord сервері (канал #osu-wiki), або у коментарях на GitHub.
• Щоб отримати допомогу з прекладом, перегляньте декілька вже об'єднаних пул реквестів для вашої мови та зв'яжіться з їх авторами, або людьми які робили огляд (приклад запиту GitHub).
• Попросіть друзів переглянути ваш переклад!

На додаток до процесу ручної перевірки, репозиторій osu! wiki має набір автоматизованих перевірок, які переконуються, що ваші зміни відповідають загальному стилю та не мають помилок оформлення. Щоб дізнатися їх статус, відкрийте вкладку Actions вашого пул реквесту і перегляньте діагностуючі повідомлення під помилками, якщо вони є.

Злиття

Ваші зміни згодом будуть переглянуті одни з тих, хто підтримує wiki, зазвичай після огляду від інших учасників. Якщо нічого не відбулося після достатньо тривалого періоду, поставте питання в коментарях пул реквесту, або в каналі #osu-wiki на osu! Discord сервері. Ваші зміни появляться на osu! wiki, невдовзі після злиття (у рідкісних випадках, це може зайняти до п'яти годин).