Ролі та обовʼязки

Будь-хто може зробити внесок у Kubernetes. Зі зростанням ваших внесків до SIG Docs, ви можете подати заявку на різні рівні членства в спільноті. Ці ролі дозволяють брати на себе більше відповідальності в спільноті. Кожна роль вимагає більше часу та відданості. Ролі є такими:

• Будь-хто: регулярні учасники документації Kubernetes
• Члени: можуть призначати та розподіляти тікети, а також надавати відгук на pull requestʼи, який не є обовʼязковим до виконання
• Рецензенти: можуть керувати рецензією документаційних pull request'ів і гарантувати якість змін
• Затверджувачі: можуть керувати рецензією документації та зливати зміни

Будь-хто

Будь-хто з обліковим записом GitHub може зробити свій внесок у Kubernetes. SIG Docs вітає всіх нових учасників!

Будь-хто може:

• Створити тікет в будь-якому репозиторії Kubernetes, включаючи kubernetes/website
• Надати відгук на pull request, який не є обовʼязковим для виконання
• Зробити внесок у локалізацію
• Запропонувати покращення у Slack або в списку розсилки SIG docs.

Після підписання CLA, будь-хто також може:

• Створити pull request для покращення наявного контенту, додавання нового контенту або написання блогу чи прикладу використання
• Створювати діаграми, графічні ресурси та вбудовані відеозаписи та відео

Для отримання додаткової інформації дивіться додавання нового контенту.

Члени

Член — це хтось, хто подав кілька pull request'ів до kubernetes/website. Члени є частиною організації Kubernetes на GitHub.

Члени можуть:

• Робити все, що зазначено в розділі Будь-хто

• Використовувати коментар /lgtm, щоб додати мітку LGTM (виглядає добре для мене) до pull request'у

  Примітка:

  Використання /lgtm запускає автоматизацію. Якщо ви хочете надати не обовʼязкове схвалення, коментар "LGTM" також працює!

• Використовувати коментар /hold, щоб заблокувати злиття для pull request'у

• Використовувати коментар /assign, щоб призначити рецензента для pull requestʼу

• Робити рецензування pull request'ів, які не є обовʼязковими

• Використовувати автоматизацію для розподілу та категоризації тікетів

• Документувати нові функції

Набуття членства

Після подання щонайменше 5 значних pull request'ів та виконання інших вимог:

1. Знайдіть двох рецензентів або затверджувачів, які стануть вашими поручителями.

   Попросіть поручительства в каналі #sig-docs на Slack або в списку розсилки SIG Docs.

   Примітка:

   Не надсилайте прямий електронний лист або пряме повідомлення у Slack окремому члену SIG Docs. Ви повинні запитати про поручительство перед поданням вашої заявки на членство.

2. Відкрийте тікет на GitHub у репозиторії kubernetes/org. Використовуйте шаблон тікета Organization Membership Request.

3. Повідомте своїх поручителів про тікет на GitHub. Ви можете:

   • Згадати їх через GitHub-імʼя у тікеті (@<GitHub-username>)

   • Надіслати їм посилання на тікет за допомогою Slack або електронної пошти.

     Поручителі схвалюють ваш запит позначкою +1. Після схвалення запиту вашими поручителями, адміністратор GitHub Kubernetes додає вас як члена. Вітаємо!

     Якщо ваш запит на членство не приймається, ви отримаєте відгук. Після врахування відгуків подайте заявку знову.

4. Прийміть запрошення до організації Kubernetes на GitHub у своєму обліковому записі електронної пошти.

   Примітка:

   GitHub надсилає запрошення на основну електронну адресу у вашому обліковому записі.

Рецензенти

Рецензенти відповідають за рецензування відкритих pull request'ів. На відміну від відгуків членів, автор PR повинен враховувати відгуки рецензентів. Рецензенти є членами команди GitHub @kubernetes/sig-docs-{language}-reviews.

Рецензенти можуть:

• Робити все, що зазначено в розділах Будь-хто та Члени

• Оглядати pull requestʼи та надавати обовʼязковий відгук

  Примітка:

  Щоб надати не обовʼязковий відгук, додайте до ваших коментарів фразу типу "Optionally: ".

• Редагувати рядки, що стосуються користувачів, у коді

• Покращувати коментарі до коду

Ви можете бути рецензентом SIG Docs або рецензентом для документів у певній предметній області.

Призначення рецензентів до pull requestʼів

Автоматизація призначає рецензентів до всіх pull requestʼів. Ви можете запросити огляд від конкретної особи, додавши коментар: /assign [@_github_handle].

Якщо призначений рецензент не прокоментував PR, інший рецензент може втрутитися. Ви також можете призначати технічних рецензентів за потреби.

Використання /lgtm

LGTM означає "Виглядає добре для мене" і вказує, що pull request є технічно точним і готовим до злиття. Усі PR потребують коментаря /lgtm від рецензента та коментаря /approve від затверджувача для злиття.

Коментар /lgtm від рецензента є обовʼязковим і запускає автоматизацію, яка додає мітку lgtm.

Як стати рецензентом

Коли ви відповідаєте вимогам, ви можете стати рецензентом SIG Docs. Рецензенти в інших SIG повинні подавати окрему заявку на статус рецензента в SIG Docs.

Щоб подати заявку:

1. Відкрийте pull request, що додає ваше імʼя користувача GitHub до розділу файлу OWNERS_ALIASES в репозиторії kubernetes/website.

   Примітка:

   Якщо ви не впевнені, де себе додати, додайте себе до sig-docs-en-reviews.

2. Призначте PR одному або кільком затверджувачам SIG Docs (імена користувачів вказані в sig-docs-{language}-owners).

Якщо заявку схвалено, лідер SIG Docs додає вас до відповідної команди GitHub. Після додавання K8s-ci-robot призначає та пропонує вас як рецензента на нові pull requestʼи.

Затверджувачі

Затверджувачі оглядають і затверджують pull requestʼи для злиття. Затверджувачі є членами команд GitHub @kubernetes/sig-docs-{language}-owners.

Затверджувачі можуть робити наступне:

• Все, що зазначено в розділах Будь-хто, Члени та Рецензенти
• Публікувати контент учасників, затверджуючи та зливаючи pull requestʼи за допомогою коментаря /approve
• Пропонувати покращення до посібника зі стилю
• Пропонувати покращення до тестів документації
• Пропонувати покращення до вебсайту Kubernetes або інших інструментів

Якщо PR вже має /lgtm, або якщо затверджувач також додає коментар /lgtm, PR автоматично зливається. Затверджувач SIG Docs повинен залишити коментар /lgtm лише на змінах, які не потребують додаткового технічного огляду.

Затвердження pull requestʼів

Затверджувачі та лідери SIG Docs є єдиними, хто може зливати pull requestʼи в репозиторій вебсайту. Це супроводжується певними обовʼязками.

• Затверджувачі можуть використовувати команду /approve, яка зливає PR в репозиторій.

  Попередження:

  Недбале злиття може зламати сайт, тому переконайтеся, що, коли ви щось зливаєте, ви впевнені в цьому.

• Переконайтеся, що запропоновані зміни відповідають посібнику зі змісту документації.

  Якщо у вас є питання, або ви не впевнені в чомусь, не соромтеся запросити додатковий огляд.

• Переконайтеся, що тести Netlify пройшли перед тим, як ви використаєте команду /approve для PR.

  

• Відвідайте попередній перегляд сторінки Netlify для PR, щоб переконатися, що все виглядає добре перед затвердженням.

• Беріть участь у графіку чергування PR Wrangler для щотижневих ротацій. SIG Docs очікує, що всі затверджувачі братимуть участь у цій ротації. Дивіться PR чергування для отримання додаткової інформації.

Як стати затверджувачем

Коли ви відповідаєте вимогам, ви можете стати затверджувачем SIG Docs. Затверджувачі в інших SIG повинні подавати окрему заявку на статус затверджувача в SIG Docs.

Щоб подати заявку:

1. Відкрийте pull request, що додає вас до розділу файлу OWNERS_ALIASES у репозиторії kubernetes/website.

   Примітка:

   Якщо ви не впевнені, де себе додати, додайте себе до sig-docs-en-owners.

2. Призначте PR одному або кільком поточним затверджувачам SIG Docs.

Якщо заявку схвалено, лідер SIG Docs додає вас до відповідної команди GitHub. Після додавання, @k8s-ci-robot призначає та пропонує вас як рецензента на нові pull request'и.

Що далі

• Прочитайте про PR чергування, роль, яку всі затверджувачі виконують по черзі.