Вклад у розвиток проекту SubQuery

... 2022-8-15 Менше 1 хвилини

# Вклад у розвиток проекту SubQuery

Ласкаво просимо! Ми хочемо подякувати вам за те, що ви розглянули можливість зробити свій вклад у проект SubQuery! Разом ми зможемо прокласти шлях до бiльш децентралізованого майбутнього.

Дана документація активно підтримується командою SubQuery. Ми дуже раді вашому вкладу у наш проект. Для початку вам необхідно форкнути наш проект GitHub та внести зміни до всіх файлів markdown документації в каталозі docs.

Нижче ви можете ознайомитись з інструкціями (не правилами), які допоможуть вам внести свій вклад у проект SubQuery. Дані інструкції допоможуть зробити участь у проекті найбільш ефективною та простою. Дотримуючись цих інструкцій, ви погоджуєтесь поважати час розробників, які керують цим проектом та розробляють його. З нашого боку, ми зробимо все можливе, щоб допомогти вам з вирішенням будь-яких проблем, з якими ви можете зіткнутися, розглянемо питання про внесення змін і разом працюватимемо над покращенням проекту. Також, ми допоможемо вам фіналізувати ваші пул реквести (pull requests).

# Наш Кодекс Поведінки

Ми серйозно ставимося до наших open source проектів спільноти, та до відповідальності. Також, ми та інші учасники дотримуємося високих стандартів спілкування. Беручи участь у нашому проекті, ви погоджуєтеся дотримуватися нашого Кодексу Поведінки (opens new window).

# Початок роботи

Вклади у наш репозиторій робляться через Issues та Pull requests (PR). Ось декілька загальних рекомендацій, що охоплюють обидва методи:

  • Перш ніж створювати власні питання та PR, за допомогою пошука переконайтеся в тому, що вони не були створені раніше.
  • Ми докладаємо всіх зусиль для того, щоб забезпечити своєчасне вирішення проблем, але, залежно від впливу даних проблем, може знадобитися більше часу на дослідження основної причини. Дружня @ згадка відправника або учасника у гілці коментарів може допомогти привернути увагу до вашої проблеми, якщо вона не вирішується.

# Як зробити вклад у Проект

# Звіт про знайдені помилки/баги

Всі помилки/баги реєструються як GitHub issues. При реєстрації проблеми постарайтеся дати детальне пояснення та опис проблеми, це допоможе нашим технічним фахівцям швидше відтворити її:

  • Щоб ідентифікувати проблему, намагайтеся використовувати зрозумілу та описову назву.
  • Опишіть точні кроки для вiдтворення проблеми.
  • Опишіть, який результат ви отримали після виконання цих кроків.
  • Поясніть, який результат ви очікували побачити замість отриманого результату, і чому.
  • При можливості додавайте скріншоти.

# Відправлення Pull Requests

Загалом, ми дотримуємось робочого процесу Git, який заснований на принципах «fork-and-pull»

  • Форкнути репозиторій у ваш обліковий запис на Github
  • Клонувати проект на ваш комп'ютер
  • Створити локальну гілку (branch) з коротким, але описовим ім'ям
  • Зберегти зміни у гілці
  • Дотримуватися правил форматування та тестування, які притаманні даному репозиторію
  • Надіслати зміни до вашого форку
  • Відкрити PR у нашому репозиторії

# Стандарт Оформлення Коду

# Повідомлення Git Commit

  • Використовуйте теперішній час («Додати об'єкт», а не «Доданий об'єкт»)
  • Використовуйте наказовий спосіб («Перемістити курсор у...», а не «Курсор переміщається у...»)
  • Обмежте перший рядок до 72 символів або ще менше

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

  • Весь код JavaScript розміщений на основі Prettier та ESLint
Останнє оновлення: August 15, 2022 23:43