diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a1cd212 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing до cloudstream-extensions-uk + +Перш за все, дякуємо за те, що ви знайшли час, щоб зробити свій внесок! ❤️ + +Всі види внесків заохочуються і цінуються. Дивіться зміст, щоб дізнатися про різні способи допомоги та деталі про те, як вони обробляються в цьому проекті. Будь ласка, обов'язково прочитайте відповідний розділ перед тим, як зробити свій внесок. Це значно полегшить роботу нам, супровідникам, і згладить досвід для всіх учасників. Спільнота з нетерпінням чекає на ваші внески. 🎉 + +> І якщо вам подобається проект, але у вас просто немає часу, щоб зробити свій внесок, нічого страшного. Є й інші прості способи підтримати проєкт і висловити свою вдячність, яким ми також будемо дуже раді: +> - Станьте зіркою проєкту +> - Напишіть про нього у Mastodon/Telegram/etc +> - Посилайтеся на цей проект в readme вашого проекту +> - Згадайте про проект на місцевих мітапах та розкажіть друзям/колегам + +## Зміст + +- [У мене є питання](#у-мене-є-питання) +- [Я хочу зробити внесок](#я-хочу-зробити-внесок) +- [Я хочу попросити додати нове джерело](#я-хочу-попросити-додати-нове-джерело) + + +## У мене є питання + +> Якщо ви хочете поставити запитання, ми припускаємо, що ви прочитали доступну [Документацію](http://recloudstream.github.io/csdocs/). + +Перед тим, як поставити запитання, найкраще пошукати існуючі [Issues](https://github.com/CakesTwix/cloudstream-extensions-uk/issues), які можуть вам допомогти. Якщо ви знайшли відповідне issue, але все ще потребуєте роз'яснень, ви можете написати своє питання в цьому issue. Також бажано спочатку пошукати відповіді в Інтернеті. + +Якщо ви все ще відчуваєте потребу поставити запитання і потребуєте роз'яснень, ми рекомендуємо зробити наступне: + +- Відкрийте [Issue](https://github.com/CakesTwix/cloudstream-extensions-uk/issues/new). +- Надайте якомога більше контексту про те, з чим ви зіткнулися. + +Після цього ми подбаємо про вирішення проблеми якомога швидше. + +## Я хочу зробити внесок + +Якщо ви хочете додати чи щось виправити, слід спершу форкнути проєкт, зробити необхідні правки та надіслати мені PR, який перегляну. + +У мене є деякі вимоги щодо оформлення назв коміту, а конкретніше робити за таким шаблоном + +- name: Commit name +> Де name - назва парсера, наприклад Aniage - aniage + +Припустімо, ви зробили зміни одразу в кількох парсерах і ви не хочете робити купу коммітів. + +- exts: Commit name + +## Я хочу попросити додати нове джерело + +Ви знайшли чудовий сайт з купою фільмів, серіалів і тд і хочете, щоб я додав його в CS3? Тоді пропоную Вам піти і зробити [Issue за шаблоном](https://github.com/CakesTwix/cloudstream-extensions-uk/issues/new?assignees=&labels=new-source&projects=&template=new_source.yml). Детально розпишіть про сайт, наявність API буде великим плюсом і спростить мені роботу з ним. + +> Напевно не потрібно писати, що я додаю джерела, де ТІЛЬКИ українська мова. Тобто HDRezka собі не додам, хоч там є українські доріжки \ No newline at end of file