Дякуємо за бажання долучитися до Exercism!
Перш ніж створювати пул-реквест, прочитаймо посібник «Як зробити чудовий пул-реквест», який допомагає з нетехнічною стороною пул-реквестів, щоб і досвід був приємним, і команді мейнтейнерів було легше.
Цей документ містить додаткові настанови, властиві саме Exercism, для різних типів пул-реквестів.
Пул-реквести для вправ
Створювати пул-реквест для концептуальної чи практичної вправи буває непросто через безліч правил, що стосуються таких вправ.
Саме тому ревʼю може забрати в мейнтейнера дві-три години і вилитися в десятки коментарів.
Щоб полегшити справу, коментарі до пул-реквесту лишатиме один основний рецензент.
Не варто засмучуватися через кількість коментарів до ревʼю: цілком нормально, коли вправа проходить кілька переписувань, перш ніж набути вигляду, який влаштує і автора, і основного рецензента.
Рекомендації
Ось кілька рекомендацій, які допоможуть зробити цей процес ще зручнішим.
Читаймо документацію
Перш ніж створювати пул-реквест для вправи, обовʼязково прочитаймо документацію про концептуальні вправи і відповідно документацію про практичні вправи.
Заздалегідь прочитана документація дуже допомагає: у ревʼю буде менше коментарів, і пул-реквест зіллють значно швидше.
Розглянемо наявні вправи (якщо вони є)
Якщо в треку вже є вправи, варто приділити час і трохи вивчити їх, щоб побачити, як вони мають вигляд і як структуровані.
Пул-реквести для практичних вправ
Подумаймо, чи справді ця зміна належить до problems-specifications
Частина вмісту практичної вправи (наприклад, її вступ) походить з її (спільних) метаданих, визначених у репозиторії problems-specifications.
Якщо є намір оновити такий вміст, варто подумати, чи не принесе ця зміна користь і іншим трекам.
Якщо так, то замість цього відкриймо пул-реквест до метаданих вправи в репозиторії problems-specifications.
Загальні рекомендації
Утримаймося від непрошених ревʼю
Усі ревʼю пул-реквестів виконують один або кілька мейнтейнерів треку, адже саме вони відповідають за затвердження всіх змін у репозиторії.
Те, що ревʼю роблять самі мейнтейнери, також допомагає уникнути суперечливих відгуків для автора пул-реквесту.
Звісно, можна лишити коментар із пропозицією допомогти з ревʼю (особливо для великих пул-реквестів) або поставити запитання, якщо помітно щось схоже на помилку.
