Настанови запиту на злиття
Настанови, які критики та учасники повинні слідувати під час публікації й перегляду запитів на злиття.
Настанови запиту на злиття
Для забезпечення процесу плавної та ефективної перевірки, як учасники, так і критики, повинні дотримуватися наступних рекомендацій під час подання та перегляду запитів на злиття.
Для меценатів
- Наочні заголовок та опис
- Використовувати чіткі та лаконічні заголовки, які узагальнюють зміни.
- Надати детальний опис того, що робить запит на злиття, чому зміни є необхідними, і будь-який відповідний контекст.
- Посилання на проблеми
- У своєму заголовку запиту на злиття додайте "GH-ISSUE-NUMBER", щоб прив'язати запит на злиття до відповідної проблеми. Це необхідно для всіх запитів на злиття.
- Невеликі, цілеспрямовані зміни
- Прагніть робити запит на злиття невеликими та зосередженими на одній проблемі чи функції. Це спрощує розуміння та надання зворотного зв'язку.
- Якість коду
- Переконайтеся, що ваш код дотримується стандартів кодування та найкращих практик проєкту.
- Вносьте коментарі, де необхідно пояснити складну логіку.
- Тестування
- Перевірте свої зміни перед надсиланням запиту на злиття.
- Якщо можливо, додайте модульні або інтеграційні тести для перевірки ваших змін.
- Документація
- Оновіть або додайте документацію, як необхідно для відображення ваших змін.
- Повідомлення коміту
- Використовуйте чіткі та описані повідомлення для комітів, які слідують традиційним комітам.
- Перевірка конфліктів
- Перед надсиланням свого запиту на злиття, переконайтеся, що ваша гілка в актуальному стані з основною гілкою щоб мінімізувати конфлікти злиття.
Для критиків
- Ви повинні ретельно переглядати запит на злиття, і запитувати зміни, якщо це необхідно.
- Надати конструктивний зворотний зв'язок і пропозиції для вдосконалення.
- Переконайтеся, що зміни відповідають стандартам кодування проєкту та найкращій практиці.
- Розгорніть запит на злиття за допомогою інтеграції dokploy, щоб переконатися, що зміни працюють належним чином.
- Переконайтеся, що документація оновлена за необхідності.
- Затвердити запит на злиття лише тоді, коли ви задоволені змінами й всі перевірки пройшли.