CONTRIBUTING_UA.md

Вказівки щодо внесків (Contributing Guidelines)

Як зробити внесок 🛠️

Крок 1: Знайти проблему

Перевірте відкриті завдання (issues) у головному репозиторію та оберіть одне, над яким хочете працювати. Або створіть нове, якщо ви знайшли помилку або маєте запит на новий функціонал.

Крок 2: Створити форк проекту 🍴

Натисніть кнопку "Fork" на головній сторінці репозиторію, щоб створити його копію в вашому обліковому запису.

Крок 3: Створити гілку 🌿

$ git checkout -b Назва_Гілки

Крок 4:

• Створити віртуальне середовище poetry Для додаткової інформації, див.: https://python-poetry.org/docs/basic-usage/
• Налаштувати проєкт, додавши свої змінні .env та додавши туди свої дані
  • TELEGRAM_BOT_TOKEN - токен вашого бота
  • CHANNEL_USERNAME - тег каналу, на який будуть відправлятись повідомлення
• Додати бота в канал та надати йому адмін-права

Крок 5: Робота над завданням 👨‍💻👩‍💻

Робіть необхідні зміни в коді або документації.

Крок 6: Тестування

Переконайтесь, що код працює у вашому локальному середовищі перед тим, як створювати Pull Request

❕ ВАЖЛИВО. Відформатуйте свій код використовуючи "Black" formatter перед тим, як створювати Pull Request

Щоб запустити Black formatter, встановіть його:

$ pip install black

Щоб відформатувати свій код, запустіть:

$ black .

Крок 7: Коміт ✅

Додайте ваші зміни через Git і створіть коміт з описовим повідомленням.

$ git add .

Створити коміт

$ git commit -m 'Ваше описове повідомлення'

УВАГА: Кожний pull request (PR) повинен містити лише один коміт. Якщо у вас є декілька комітів, їх потрібно об'єднати (squash).

Крок 8: Працювати віддалено 🌍

Коли ваша робота готова і відповідає конвенціям проекту, завантажте зміни на ваш форк:

# Відправити вашу роботу до вашого віддаленого репозиторію
$ git push -u origin Назва_Гілки

Крок 9: Створити запит на злиття (Pull Request) ➡️

Перейдіть на сторінку вашого форку на GitHub і натисніть "New Pull Request". Перевірте, що зміни відображаються правильно, і надішліть запит на злиття.