Перейти к содержанию

Помочь FastAPI - Получить помощь

Нравится ли вам FastAPI?

Хотели бы вы помочь FastAPI, его пользователям и автору?

Или вам нужна помощь с FastAPI?

Есть очень простые способы помочь (несколько из них требуют всего один или два клика).

Также есть несколько способов получить помощь.

Подписаться на новостную рассылку

Вы можете подписаться на редкую новостную рассылку FastAPI и его друзья, чтобы быть в курсе:

  • Новостей о FastAPI и его друзьях 🚀
  • Руководств 📝
  • Возможностей ✨
  • Изменений, нарушающих совместимость 🚨
  • Советов и хитростей ✅

Подписаться на FastAPI в Twitter

Подписаться на @fastapi в Twitter для получения наисвежайших новостей о FastAPI. 🐦

Добавить FastAPI звезду на GitHub

Вы можете добавить FastAPI "звезду" на GitHub (кликнув на кнопку звезды в верхнем правом углу экрана): https://github.com/fastapi/fastapi. ⭐️

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

Отслеживать свежие выпуски в репозитории на GitHub

Вы можете "отслеживать" FastAPI на GitHub (кликнув по кнопке "watch" наверху справа): https://github.com/fastapi/fastapi. 👀

Там вы можете выбрать "Releases only".

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

Связаться с автором

Можно связаться со мной (Себастьян Рамирез / tiangolo), автором FastAPI.

Вы можете:

  • Подписаться на меня на GitHub.
    • Посмотреть другие мои open-source проекты, которые могут быть вам полезны.
    • Подписавшись на меня, вы сможете видеть, когда я создаю новый проект с открытым исходным кодом.
  • Подписаться на меня в Twitter или в Mastodon.
    • Поделиться со мной, как вы используете FastAPI (мне это очень интересно).
    • Узнавать обо всех моих анонсах и новых выпусках инструментов.
    • Вы также можете подписаться на @fastapi в Twitter (это отдельная учетная запись).
  • Подписаться на меня в LinkedIn.
    • Узнавать обо всех моих анонсах и новых выпусках инструментов (хотя я чаще использую Twitter 🤷‍♂).
  • Читайте мои статьи (или подпишитесь на меня) на Dev.to или Medium.
    • Читайте другие идеи, статьи и обзор инструментов, которые я создал.
    • Подпишитесь, чтобы увидеть, когда я публикую что-то новое.

Оставить сообщение в Twitter о FastAPI

Оставьте сообщение в Twitter о FastAPI и дайте мне и другим узнать, почему он вам нравится. 🎉

Мне очень нравится узнавать о том, как FastAPI используется, что вам нравится в нем, на каких проектах/компаниях вы его применяете и т.п.

Оставить голос за FastAPI

Помочь другим с вопросами на GitHub

Вы можете попробовать помочь другим с их вопросами на:

Во многих случаях вы можете уже знать ответ на эти вопросы. 🤓

Если вы будете много помогать людям с их вопросами, вы можете стать официальным Экспертом FastAPI. 🎉

Только помните, самое важное — старайтесь быть добрыми. Люди приходят со своими разочарованиями и в большинстве случаев не задают вопросы лучшим образом, но старайтесь проявить максимум доброты. 🤗

Идея сообщества FastAPI заключается в доброжелательности и гостеприимстве. В то же время не допускайте издевательств или неуважительного поведения к другим. Мы должны заботиться друг о друге.

Как помочь другим с вопросами (в обсуждениях или в вопросах):

Понять вопрос

  • Удостоверьтесь, что понимаете цель и обстоятельства задающего вопрос.

  • Затем удостоверьтесь, что вопрос (в подавляющем большинстве случаев это именно вопрос) для вас ясен.

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

  • Если вопрос вам непонятен, запросите больше деталей.

Воспроизвести проблему

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

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

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

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

Предложить решения

  • После того как вы поняли вопрос, вы можете дать возможный ответ.

  • В большинстве случаев лучше понять их основную проблему или обстоятельства, потому что может быть лучший способ ее решения, чем то, что они пытаются сделать.

Попросить закрыть

Если они ответят, высока вероятность, что вам удалось решить проблему, поздравляю, вы - герой! 🦸

  • Если вопрос решен, попросите их:

    • В GitHub Discussions: отметить комментарий как ответ.
    • В GitHub Issues: закрыть issue.

Отслеживать репозиторий на GitHub

Вы можете "отслеживать" FastAPI на GitHub (кликнув по кнопке "watch" наверху справа): https://github.com/fastapi/fastapi. 👀

Если вы выберете "Watching" вместо "Releases only", то получите уведомления, когда кто-то создаст новый issue или вопрос. Вы также можете указать, что хотите получать уведомления только о новых issues, обсуждениях или пул-реквестах и т.д.

Затем вы можете попробовать помочь им решить эти вопросы.

Задавать вопросы

Вы можете создать новый вопрос в репозитории на GitHub, например, чтобы:

  • Задать вопрос или спросить о проблеме.
  • Предложить новую возможность.

Заметка: если вы это сделаете, я попрошу вас также помочь другим. 😉

Проверять пул-реквесты

Вы можете помочь мне проверять пул-реквесты от других участников.

И повторюсь, постарайтесь быть добрыми. 🤗

Вот что стоит иметь в виду при проверке пул-реквестов:

Понять проблему

  • Во-первых, убедитесь, что понимаете проблему, которую пул-реквест пытается решить. Возможно, это будет сделано через более длинное обсуждение в Discussion или issue на GitHub.

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

Не переживайте о стиле

  • Не стоит слишком беспокоиться о таких вещах, как стиль сообщений в коммитах или количество коммитов. При слиянии пул-реквеста с основной веткой, я буду сжимать и настраивать всё вручную.

  • Также не беспокойтесь о правилах стиля, уже есть автоматизированные инструменты, которые это проверяют.

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

Проверить код

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

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

Информация

К сожалению, я не могу просто доверять PR, которые просто получили несколько одобрений.

Было несколько случаев, когда пул-реквесты имели 3, 5 или больше одобрений, вероятно из-за привлекательного описания, но когда я проверял эти пул-реквесты, они оказывались сломаны, содержали ошибки или вовсе не решали проблему, которую, как они утверждали, должны были решить. 😅

Потому это действительно важно - проверять и запускать код, и комментарием уведомлять меня, что вы проделали эти действия. 🤓

  • Если можно упростить пул-реквест, вы можете попросить об этом, но нет нужды быть слишком дотошным, может существовать много субъективных точек зрения (и у меня своя тоже будет 🙈), так что лучше, если вы сосредоточитесь на фундаментальных вещах.

Тестирование

  • Помогите мне проверить, что у пул-реквеста есть тесты.

  • Проверьте, что тесты падают до пул-реквеста. 🚨

  • Затем проверьте, что тесты проходят после пул-реквеста. ✅

  • Многие пул-реквесты не имеют тестов, вы можете напомнить об их добавлении или даже предложить какие-либо тесты сами. Это одна из тех вещей, которые отнимают много времени, и вы можете оказать значительную помощь в этом.

  • Затем добавьте комментарий, что вы испробовали в ходе проверки. Таким образом я буду знать, как вы произвели проверку. 🤓

Создать пул-реквест

Вы можете внести вклад в исходный код с помощью пул-реквестов, например:

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

Помочь поддерживать FastAPI

Помогите мне поддерживать FastAPI! 🤓

Предстоит еще много работы, и в большей части из нее вы можете помочь.

Основные задачи, которые вы можете сделать сейчас:

Эти две задачи — те, что чаще всего занимают время. Это основная работа по поддержке FastAPI.

Если вы можете помочь мне с этим, вы помогаете поддерживать FastAPI и следить за тем, чтобы он продолжал развиваться быстрее и лучше. 🚀

Подключиться к чату

Подключайтесь к 👥 чату на сервере Discord 👥 и общайтесь с другими участниками сообщества FastAPI.

Подсказка

Для вопросов, задавайте их в GitHub Discussions, там больше шансов получить помощь от Экспертов FastAPI.

Используйте чат только для других общих разговоров.

Не использовать чаты для вопросов

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

На GitHub шаблон поможет вам задать правильный вопрос, чтобы легче было получить хороший ответ или даже решить проблему самостоятельно до того, как вы его зададите. И на GitHub я могу быть уверен, что всегда отвечаю на все, даже если это займет время. Я не могу сделать то же самое в чатах. 😅

Общение в чатах не так легко ищется, как на GitHub, поэтому вопросы и ответы могут затеряться в разговоре. И только запросы на GitHub учитываются для получения звания Эксперт FastAPI, поэтому, вероятнее всего, вы получите больше внимания на GitHub.

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

Спонсорство для автора

Если ваш продукт/компания зависят от FastAPI или связаны с ним, и вы хотите донести до пользователей, вы можете также спонсировать автора (меня) через GitHub sponsors. В зависимости от уровня поддержки, вы можете получить дополнительные преимущества, такие как знак в документации. 🎁

Благодарю! 🚀