Перейти до основного вмісту

Надсилання змін

Цей посібник охоплює процес внесення покращень коду в Rayforge.

Створіть гілку функціональності​

Створіть описову гілку для ваших змін:

git checkout -b feature/your-feature-name
# або
git checkout -b fix/issue-number-description

Внесіть ваші зміни​

  • Дотримуйтесь існуючого стилю коду та конвенцій
  • Пишіть чисті, сфокусовані коміти з чіткими повідомленнями
  • Додавайте тести для нової функціональності
  • Оновлюйте документацію за потреби

Протестуйте ваші зміни​

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

# Запустити всі тести та лінтинг
pixi run test
pixi run lint

Синхронізуйте з upstream​

Перед створенням pull request синхронізуйте з upstream репозиторієм:

# Отримайте останні зміни
git fetch upstream

# Ребейзніть вашу гілку на останній main
git rebase upstream/main

Надішліть Pull Request​

  1. Запуште вашу гілку до вашого форку:

    git push origin feature/your-feature-name

  2. Створіть pull request на GitHub з:

    • Чіткою назвою, що описує зміну
    • Детальним описом того, що ви змінили і чому
    • Посиланням на будь-які пов'язані issues
    • Скріншотами якщо зміна впливає на UI

Процес код-рев'ю​

  • Всі pull requests потребують рев'ю перед злиттям
  • Оперативно реагуйте на відгуки та вносьте запитувані зміни
  • Тримайте дискусію сфокусованою та конструктивною

Вимоги до злиття​

Pull requests зливаються коли вони:

  • Проходять всі автоматизовані тести
  • Дотримуються стилю кодування проекту
  • Включають відповідні тести для нової функціональності
  • Мають оновлення документації за потреби
  • Затверджені принаймні одним мейнтейнером

Додаткові вказівки​

Повідомлення комітів​

Використовуйте чіткі, описові повідомлення комітів:

  • Починайте з великої літери
  • Тримайте перший рядок до 50 символів
  • Використовуйте наказовий спосіб ("Додати функцію" не "Додано функцію")
  • Включайте більше деталей у тіло за потреби

Малі, сфокусовані зміни​

Тримайте pull requests сфокусованими на одній функції або виправленні. Великі зміни сл розділяти на менші, логічні частини.

:::порада Спочатку обговоріть Для великих змін спочатку відкрийте issue щоб обговорити ваш підхід перед інвестуванням значного часу. :::

:::примітка Потрібна допомога? Якщо ви не впевнені щодо будь-якої частини процесу внесення внеску, не соромтеся просити допомоги в issue або дискусії. :::