Вклад

⭐ УЧАСТИЕ

Вклад в Lightning Bounties

Прежде всего, благодарим вас за то, что уделили время на то, чтобы внести свой вклад в наш проект! ❤️

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

А если вам нравится проект, но у вас просто нет времени для участия, это нормально. Есть другие простые способы поддержки проекта и выражения вашей благодарности, мы были бы также очень рады:

  • Поставьте звезду проекту

  • Твитните о нем

  • Упомяните этот проект в readme вашего проекта

  • Расскажите о проекте на местных встречах и сообщите своим друзьям/коллегам

Оглавление

  • У меня есть вопрос

  • Я хочу внести свой вклад

    • Сообщения об ошибках

    • Предложение улучшений

    • Ваш первый вклад в коде

    • Улучшение документации

  • Гайдлайны

    • Сообщения о коммитах

  • Присоединяйтесь к команде проекта

У меня есть вопрос

Если вы хотите задать вопрос, мы предполагаем, что вы уже прочитали доступные Документы.

Перед тем как задать вопрос, лучше всего поискать существующие Проблемы, которые могут вам помочь. В случае, если вы нашли подходящую проблему и все еще нуждаетесь в разъяснении, вы можете задать свой вопрос в этой ветке обсуждения. Также рекомендуется сначала поискать ответы в интернете.

Если позже вы все еще почувствуете необходимость задать вопрос и нуждаетесь в разъяснениях, то мы рекомендуем следующее:

  • Откройте Проблему.

  • Предоставьте как можно больше контекста о том, с чем вы столкнулись.

  • Укажите версии проекта и платформы (python, npm и т.д.), в зависимости от того, что кажется релевантным.

Мы затем займемся этой проблемой как можно скорее.

Я хочу внести свой вклад

Правовое уведомление

Внося свой вклад в этот проект, вы должны согласиться с тем, что на 100% является автором контента, что у вас есть необходимые права на контент и что контент, который вы вносите, может быть предоставлен по лицензии проекта.

Сообщения об ошибках

Перед отправкой отчета об ошибке

Хороший отчет об ошибке не должен заставлять других догонять вас за дополнительной информацией. Поэтому мы просим вас тщательно исследовать, собирать информацию и детально описывать проблему в вашем отчете. Пожалуйста, пройдите следующие шаги заранее, чтобы помочь нам исправить любую возможную ошибку как можно быстрее.

  • Убедитесь, что вы используете последнюю версию.

  • Определите, является ли ваша ошибка действительно багом, а не ошибкой с вашей стороны, например, использование несовместимых компонентов/версий среды (Убедитесь, что вы прочитали документацию. Если вы ищете поддержку, вы можете захотеть проверить этот раздел).

  • Чтобы узнать, сталкивались ли другие пользователи с такой же проблемой (и, возможно, уже решили ее), проверьте, не существует ли уже отчета об ошибке для вашей ошибки или ошибки в баг-трекере.

  • Также убедитесь, что вы искали в интернете (включая Stack Overflow), чтобы увидеть, обсуждали ли пользователи за пределами сообщества GitHub эту проблему.

  • Соберите информацию об ошибке:

    • Трассировка стека (Traceback)

    • ОС, платформа и версия (Windows, Linux, macOS, x86, ARM)

    • Версия интерпретатора, компилятора, SDK, среды выполнения, менеджера пакетов, в зависимости от того, что кажется актуальным.

    • Возможно, ваши входные данные и результат

    • Вы можете надежно воспроизвести эту проблему? И можно ли ее воспроизвести на более ранних версиях?

Как отправить хороший отчет об ошибке?

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

Мы используем проблемы GitHub для отслеживания багов и ошибок. Если вы столкнулись с проблемой в проекте:

  • Откройте Проблему. (Поскольку на данный момент мы не можем быть уверены, является ли это багом или нет, мы просим вас пока не упоминать о баге и не маркировать проблему.)

  • Опишите поведение, которого вы ожидали, и фактическое поведение.

  • Пожалуйста, предоставьте как можно больше контекста и опишите шаги для воспроизведения так, чтобы кто-то другой мог воспроизвести проблему на своем устройстве. Обычно это включает в себя ваш код. Для хороших отчетов об ошибках вы должны изолировать проблему и создать уменьшенный тестовый случай.

  • Предоставьте информацию, которую вы собрали в предыдущем разделе.

Как только он будет отправлен:

  • Команда проекта будет маркировать проблему соответственно.

  • Член команды будет пытаться воспроизвести проблему с помощью вашим предоставленных шагов. Если нет шагов воспроизведения или нет очевидного способа воспроизвести проблему, команда попросит вас о таких шагах и пометит проблему как необходимо-воспроизвести. Ошибки с пометкой необходимо-воспроизвести не будут решаться, пока они не будут воспроизведены.

  • Если команда сможет воспроизвести проблему, она будет помечена как необходимо-исправить, а также возможно другие метки (такие как критический), и проблема будет оставлена для реализации кем-то.

Предложение улучшений

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

Перед представлением улучшения

  • Убедитесь, что вы используете последнюю версию.

  • Внимательно прочитайте документацию и выясните, не охватывается ли уже функционал, возможно, в отдельной конфигурации.

  • Выполните поиск, чтобы увидеть, не предлагалось ли уже такое улучшение. Если это так, добавьте комментарий к существующей проблеме, а не открывайте новую.

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

Как представить хорошее предложение об улучшении?

Предложения об улучшениях отслеживаются как проблемы GitHub.

  • Используйте четкое и описательное название для идентификации предложения.

  • Предоставьте пошаговое описание предлагаемого улучшения с максимальным количеством деталей.

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

  • Вы можете захотеть включить скриншоты и анимированные GIF-изображения, которые помогают вам продемонстрировать шаги или указать на ту часть, к которой относится предложение. Вы можете использовать этот инструмент для записи GIF-ов на macOS и Windows, и этот инструмент или этот инструмент на Linux.

  • Объясните, почему это улучшение было бы полезно большинству пользователей Lightning Bounties. Вы также можете захотеть указать на другие проекты, которые лучше это решили, и которые могут служить источником вдохновения.

Ваш первый вклад в код

Чтобы внести свой первый вклад в код, следуйте этим шагам:

  1. Сделайте форк репозитория и клонируйте его

    • Сделайте форк репозитория на GitHub.

    • Клонируйте форкнутый репозиторий на ваш компьютер.

  2. Измените код

    • Откройте файл src/main.py и внесите желаемые изменения, чтобы отразить ваши модификации.

  3. Сгенерировать Lightning Invoice

    • Создайте счет Lightning для платежа.

    • Скопируйте строку счета в файл reward.txt.

  4. Совершите коммит и отправьте запрос на слияние

    • Добавьте и совершите коммит с вашими изменениями в локальный репозиторий.

    • Отправьте запрос на слияние в базовый репозиторий.

  5. Проведите платеж

    • Действие GitHub будет запущено, чтобы запросить "пылевой" платеж от вас (контрибьютора) в базовый репозиторий (владелец).

    • Выберите действие с надписью "Пожалуйста, оплатите счет: lnbc10n1..." (не тот, который говорит "Extracted values:...").

    • Ожидайте подтверждения платежа.

    • Как только платеж будет подтвержден, вы получите сообщение с благодарностью за платеж!

  6. Запрос в рецензента

    • Попросите рецензента просмотреть ваш запрос на слияние.

    • Выберите Энрике или Уилла для этого теста.

  7. Рецензия и анализ

    • Через несколько секунд начнется новое действие.

    • Сначала будет сказано "Платеж получен, сидите спокойно, выполняется запрос к openai".

    • Примерно через 30 секунд он вернется с кратким изложением ваших изменений и анализом уязвимостей безопасности.

  8. Слияние запроса на слияние

    • Мы будем следить за вашим запросом на слияние и попытаемся его сделать за вас. Как контрибьютор, вы не имеете полномочий сделать это самостоятельно.

Альтернативно, если вы предпочитаете воспроизвести нашу работу в своем собственном репозитории:

  • Скопируйте содержимое директории .github/ в свой репозиторий.

  • Измените файл main.py в соответствии с этим.

  • Настройте следующие секреты в настройках вашего репозитория:

    • OPENAI_API_KEY

    • PAY_INVOICE_KEY (ключ администратора для LNBits)

    • WALLET_API_KEY (ключ для чтения/выписывания счетов для LNBits)

    • WALLET_BASE_URL (URL вашего экземпляра LNBits)

Улучшение документации

Если вы хотите улучшить документацию, пожалуйста, следуйте тому же процессу, как описано в разделе "Ваш первый вклад в коде", но сосредоточьтесь на обновлении файлов документации вместо кода.

Гайдлайны

Сообщения о коммитах

При написании сообщений о коммитах, пожалуйста, следуйте этим рекомендациям:

  • Используйте настоящее время ("Добавить функцию", а не "Функция добавлена")

  • Используйте повелительное наклонение ("Переместите курсор в...", а не "Курсор перемещается в...")

  • Ограничьте первую строку 72 символами или меньше

  • Свободно ссылайтесь на issues и pull requests после первой строки

Присоединяйтесь к команде проекта

Если вы заинтересованы в присоединении к команде проекта, пожалуйста, свяжитесь с нами по адресу founders@lightningbounties.com.

Благодарность

Этот гайд основан на contributing-gen. Создайте свой собственный!

Отказ от ответственности

!!! предупреждение "Бета-версия" Этот проект в настоящее время находится в бета-версии и активно развивается. Процесс тестирования, описанный в этом документе, может часто меняться по мере обновления и улучшения.

Если у вас есть вопросы или вы хотели бы обсудить возможные вклады, пожалуйста, напишите нам на founders@lightningbounties.com.

PreviousLICENSE.mdNextЧаВо по Lightning Bounties

Last updated