Skip to content

CONTRIBUTING-ukr.md

Latest commit

 

History

History
106 lines (91 loc) · 11.7 KB

CONTRIBUTING-ukr.md

File metadata and controls

106 lines (91 loc) · 11.7 KB

🤝 Внесок у NeoBleeper

По-перше, дякуємо, що розглядаєте можливість зробити внесок у NeoBleeper! Ваш внесок є невід'ємною частиною успіху цього проєкту. Незалежно від того, чи повідомляєте ви про помилку, пропонуєте функцію, покращуєте документацію, завантажуєте застарілий файл BMM або NBPML, чи надсилаєте код, ваша участь високо цінується.

📑 Зміст

  1. Кодекс поведінки
  2. Як я можу зробити свій внесок?
  3. Процес запиту на зняття контенту
  4. Посібники зі стилю
  5. Підтримка спільноти

🌟 Кодекс поведінки

Беручи участь у цьому проєкті, ви погоджуєтеся дотримуватися Кодексу Поведінка. Будь ласка, будьте шанобливими та уважними до інших членів спільноти. Дивіться файл CODE_OF_CONDUCT-ukr.md для отримання детальної інформації.

🤝🙋‍♂️ Як я можу зробити свій внесок?

🪲 Звіти про помилки

Якщо ви знайшли помилку в NeoBleeper, будь ласка, створіть проблему та вкажіть такі деталі:

  • Чіткий та описовий заголовок.
  • Версію NeoBleeper або хеш коміту, якщо це можливо.
  • Кроки для відтворення проблеми або фрагмент коду.
  • Очікувана та фактична поведінка.
  • Будь-які інші відповідні деталі, включаючи скріншоти або журнали аварій.

💭 Запити на функції

Ми раді вашим ідеям! Щоб запросити функцію:

  1. Перевірте проблеми, щоб побачити, чи хтось інший вже запитував її.
  2. Якщо ні, відкрийте нову проблему та поділіться детальним описом, включаючи:
  • Передумови запиту.
  • Чому це цінно.
  • Потенційний вплив, ризики або міркування.

👩‍💻 Внесок у код

  1. Зробіть форк репозиторію та створіть нову гілку від main. Назвіть свою гілку якось описово, наприклад, feature/add-tune-filter.
  2. Відкрийте папку репозиторію у Visual Studio:
    • Переконайтеся, що у вас встановлено Visual Studio з необхідними робочими навантаженнями (наприклад, ".NET desktop development" для NeoBleeper).
    • Клонуйте свій форк репозиторію на локальний комп'ютер (ви можете використовувати інтегровані інструменти Git Visual Studio або Git CLI).
    • Після клонування відкрийте файл рішення (.sln) у Visual Studio.
  3. Встановлення пакетів NuGet:
    • Відновіть усі необхідні залежності, натиснувши Restore NuGet Packages у верхній панелі або виконавши dotnet restore з терміналу.
  4. Додайте зміни:
    • Використовуйте такі функції Visual Studio, як IntelliSense, налагодження та форматування коду, щоб ефективно робити свій внесок.
    • Переконайтеся, що включено належні тести та всі існуючі тести пройдено.
    • Переконайтеся, що ваш код відповідає посібнику зі стилю.
  5. Додайте своє ім'я або псевдонім на сторінку «Про нас»:
    • Відкрийте файл about_neobleeper.cs та знайдіть компонент listView1.
    • Виберіть компонент listView1 у дизайнері Visual Studio.
    • Натисніть маленьку стрілку у верхньому правому куті компонента, щоб відкрити випадаюче меню.
    • Виберіть Редагувати елементи, щоб відкрити редактор колекції елементів ListView.
    • Додайте новий ListViewItem:
      • Введіть своє ім'я або псевдонім у властивість Text.
      • Для ваших внесків/завдань:
        • Знайдіть властивість SubItems.
        • Натисніть на потрійну крапку (...) праворуч від поля (Колекція).
        • Додайте або відредагуйте SubItem з коротким описом ваших завдань.
    • Якщо ви вже додали своє ім'я, відредагуйте SubItem або оновіть існуючий запис, перш ніж фіксувати зміни.
  6. Перевірте свій код:
    • Запустіть тести за допомогою Test Explorer у Visual Studio.
    • Виправте будь-які невдалі тести та перевірте свої зміни.
  7. Фіксуйте свої зміни чіткими та лаконічними повідомленнями.
    • Використовуйте інтегровані інструменти Git у Visual Studio для розміщення та фіксації змін.
  8. Надішліть свою гілку та відкрийте запит на зняття змін у репозиторії.
  9. Будьте готові співпрацювати з рецензентами та вносити необхідні зміни.

🧾 Документація

Покращення нашої документації – один із найпростіших способів зробити свій внесок! Не соромтеся додавати або оновлювати приклади, уточнювати розділи або покращувати загальну читабельність.

🎼 Внесок файлів BMM та NBPML

NeoBleeper підтримує застарілі файли BMM (Bleeper Music Maker) та NBPML (NeoBleeper Project Markup Language). Якщо ви робите свій внесок або працюєте з цими типами файлів, переконайтеся в наступному:

  • Перевірте, чи файли BMM правильно обробляються та відображаються належним чином у NeoBleeper.
  • Перевірте сумісність як зі застарілими форматами, так і з поточною реалізацією.
  • Для файлів NBPML дотримуйтесь останніх специфікацій мови розмітки проекту NeoBleeper.

Якщо у вас виникнуть проблеми, характерні для цих форматів файлів, дотримуйтесь інструкцій у розділі «Звіти про помилки». Також вітаються запити на покращену підтримку файлів BMM та NBPML!

⬇️ Процес запитів на зчитування

Усі подання слід здійснювати через запити на зчитування. Ось процес:

  1. Заповніть шаблон запиту на зчитування.
  2. Переконайтеся, що ваш запит на зчитування не дублює існуючі.
  3. Додайте деталі про ваші зміни в описі, посилаючись на пов'язані проблеми, де це можливо.
  4. Врахуйте всі коментарі або запити на зміни від рецензентів.
  5. Запити на зчитування повинні пройти всі перевірки CI/CD, включаючи тести та перевірки якості коду.

📖 Посібники зі стилю

✨ Стиль коду

Дотримуйтесь .NET Coding Conventions. Ключові моменти включають:

  • Надавайте перевагу автоматичним властивостям над публічними полями.
  • Використовуйте var для локальних змінних, коли тип очевидний.
  • Уникайте магічних рядків та чисел. Використовуйте константи або переліки.

📒 Примітки щодо C#

  • Розмістіть { у тому ж рядку, що й попередній код.
  • Використовуйте PascalCase для назв класів та методів, а camelCase для локальних змінних.
  • Дотримуйтесь Керівництва Microsoft з іменування.

👨‍👩‍👧‍👦 Підтримка спільноти

Якщо у вас виникли запитання, не соромтеся відкривати обговорення на GitHub або звертатися через розділ проблем. Ми закликаємо всіх ділитися знаннями та допомагати колегам.

Дякуємо за ваш внесок у NeoBleeper та допомогу у створенні чогось неймовірного!