Вклад в SubQuery

Добро пожаловать и большое спасибо за то, что рассмотрели возможность внести свой вклад в этот проект SubQuery! Вместе мы сможем создать путь к более децентрализованному будущему.

Примечание Эта документация активно модерируется командой SubQuery. Мы рады вашим вкладам. Вы можете сделать это, создав форк нашего проекта на GitHub и внеся изменения во все файлы разметки документации в каталоге `docs`. :::

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

Нормы поведения

Мы серьезно относимся к проектам и ответственности нашего сообщества с открытым исходным кодом и требуем от себя и других участников высоких стандартов общения. Участвуя и внося свой вклад в этот проект, вы соглашаетесь соблюдать наш Кодекс поведенияopen in new window.

Приступая к работе

Вклад в наши репозитории осуществляется через Issues и Pull Requests (PRs). Несколько общих рекомендаций, которые охватывают оба варианта:

  • Ищите существующие Замечания и PR, прежде чем создавать собственные.
  • Мы прилагаем все усилия, чтобы обеспечить своевременное решение проблем, но, в зависимости от последствий, может потребоваться некоторое время, чтобы исследовать основную причину. Дружественное @ упоминание в ветке комментариев отправителю или участнику может помочь привлечь внимание, если ваша задача блокируется.

Как сделать вклад

Сообщить об ошибках

Ошибки отслеживаются как проблемы на GitHub. При регистрации проблемы объясните ее суть и включите дополнительные сведения, которые помогут специалистам по сопровождению воспроизвести проблему:

  • Чтобы идентифицировать проблему, используйте понятное и описательное название.
  • Опишите точные шаги для воспроизведения проблемы.
  • Опишите поведение, которое вы наблюдали после выполнения шагов.
  • Объясните, какое поведение вы должны увидеть вместо этого и почему.
  • Если возможно, включите скриншоты

Отправка Pull Request'ов

В целом, мы следуем рабочему процессу Git "fork-and-pull":

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

Контрагенты кодирования

Сообщения Git Commit

  • Используйте настоящее время ("Добавить функцию", а не "Добавлена функция").
  • Используйте повелительное наклонение ("Move cursor to...", а не "Moves cursor to...").
  • Ограничьте первую строку 72 символами или менее.

Руководство по стилю JavaScript

  • Весь код JavaScript проверяется с помощью Prettier и ESLint.