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

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

::: Інформаційна замітка Ця документація активно підтримується командою SubQuery. Ми вітаємо ваші внески. Ви можете зробити це, розгалузивши наш проект на GitHub і внісши зміни в усі файли документації markdown в каталозі docs. :::

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

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

Ми серйозно ставимося до проектів і відповідальності нашої спільноти з відкритим вихідним кодом і вимагаємо від себе та інших учасників високих стандартів спілкування. Беручи участь і вносячи свій внесок у цей проект, ви погоджуєтеся дотримуватися нашого кодексу поведінкиopen in new window.

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

Внесок в наші репозиторії здійснюється через проблеми і запити на Витяг (PRS). Кілька загальних рекомендацій, які охоплюють обидва варіанти:

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

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

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

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

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

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

В цілому, ми дотримуємося робочого процесу Git "fork-and-pull":

  • Перенесіть репозиторій на свій обліковий запис Github.
  • Клонуйте проект на свій комп'ютер.
  • Створіть локальну гілку з коротким, але описовим назвою.
  • Зафіксуйте зміни в гілці.
  • Дотримуйтесь усіх рекомендацій щодо форматування та тестування, характерних для цього сховища.
  • Внесіть зміни у свою вилку.
  • Відкрийте PR у нашому сховищі.

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

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

  • Використовуйте даний час ("Додати функцію", а не"додана функція").
  • Використовуйте наказовий спосіб ("Перемістити курсор на..." не "Переміщує курсор на...").
  • Обмежте перший рядок 72 символами або менше.

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

  • Весь код JavaScript перевіряється за допомогою Prettier і ESLint.