Вклад в SubQuery

... 2022-8-5 Меньше 1 минуты

# Вклад в SubQuery

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

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

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

# Кодекс поведения

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

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

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

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

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

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

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

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

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

В общем, мы следуем рабочему процессу Git, основанному на принципах «fork-and-pull»

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

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

# Сообщения Git Commit

  • Используйте настоящее время («Добавить объект», а не «Добавлен объект»)
  • Используйте повелительное наклонение («Переместить курсор в...», а не «Перемещен курсор в...»)
  • Ограничьте первую строку до 72 символов или меньше

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

  • Весь код JavaScript размещен на основе Prettier и ESLint
Последнее обновление: August 5, 2022 10:08