Browse Source
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Yurii Motov <[email protected]>pull/15675/head
Sebastián Ramírez
3 days ago
committed by
GitHub
GitHub
10 changed files with 93 additions and 263 deletions
@ -1,255 +1,87 @@ |
|||
# Помочь FastAPI - Получить помощь { #help-fastapi-get-help } |
|||
# Помощь { #help } |
|||
|
|||
Нравится ли Вам **FastAPI**? |
|||
Хотите помочь FastAPI или получить помощь по FastAPI? |
|||
|
|||
Хотели бы Вы помочь FastAPI, другим пользователям и автору? |
|||
|
|||
Или Вы хотите получить помощь по **FastAPI**? |
|||
|
|||
Есть несколько очень простых способов помочь (иногда достаточно всего лишь одного-двух кликов). |
|||
|
|||
И также есть несколько способов получить помощь. |
|||
Есть очень простые способы помочь и получить помощь. |
|||
|
|||
## Подписаться на новостную рассылку { #subscribe-to-the-newsletter } |
|||
|
|||
Вы можете подписаться на редкую [новостную рассылку **FastAPI и его друзья**](newsletter.md) и быть в курсе о: |
|||
|
|||
* Новостях о FastAPI и его друзьях 🚀 |
|||
* Руководствах 📝 |
|||
* Возможностях ✨ |
|||
* Ломающих изменениях 🚨 |
|||
* Подсказках и хитростях ✅ |
|||
|
|||
## Подписаться на FastAPI в X (Twitter) { #follow-fastapi-on-x-twitter } |
|||
|
|||
[Подписаться на @fastapi в **X (Twitter)**](https://x.com/fastapi) для получения наисвежайших новостей о **FastAPI**. 🐦 |
|||
|
|||
## Добавить **FastAPI** звезду на GitHub { #star-fastapi-in-github } |
|||
|
|||
Вы можете добавить FastAPI "звезду" на GitHub (кликнув на кнопку звезды в правом верхнем углу): [https://github.com/fastapi/fastapi](https://github.com/fastapi/fastapi). ⭐️ |
|||
|
|||
Чем больше звёзд, тем легче другим пользователям найти проект и увидеть, что он уже оказался полезным для многих. |
|||
|
|||
## Отслеживать свежие выпуски в репозитории на GitHub { #watch-the-github-repository-for-releases } |
|||
|
|||
Вы можете "отслеживать" FastAPI на GitHub (кликнув по кнопке "watch" наверху справа): [https://github.com/fastapi/fastapi](https://github.com/fastapi/fastapi). 👀 |
|||
|
|||
Там же Вы можете выбрать "Releases only". |
|||
|
|||
С такой настройкой Вы будете получать уведомления на вашу электронную почту каждый раз, когда появится новый релиз (новая версия) **FastAPI** с исправлениями ошибок и новыми возможностями. |
|||
|
|||
## Связаться с автором { #connect-with-the-author } |
|||
|
|||
Можно связаться со [мной (Sebastián Ramírez / `tiangolo`)](https://tiangolo.com), автором. |
|||
|
|||
Вы можете: |
|||
|
|||
* [Подписаться на меня на **GitHub**](https://github.com/tiangolo). |
|||
* Посмотреть другие мои проекты с открытым кодом, которые могут быть полезны Вам. |
|||
* Подписаться, чтобы видеть, когда я создаю новый проект с открытым кодом. |
|||
* [Подписаться на меня в **X (Twitter)**](https://x.com/tiangolo) или в [Mastodon](https://fosstodon.org/@tiangolo). |
|||
* Поделиться со мной, как Вы используете FastAPI (я обожаю это читать). |
|||
* Узнавать, когда я делаю объявления или выпускаю новые инструменты. |
|||
* Вы также можете [подписаться на @fastapi в X (Twitter)](https://x.com/fastapi) (это отдельный аккаунт). |
|||
* [Подписаться на меня в **LinkedIn**](https://www.linkedin.com/in/tiangolo/). |
|||
* Узнавать, когда я делаю объявления или выпускаю новые инструменты (хотя чаще я использую X (Twitter) 🤷♂). |
|||
* Читать, что я пишу (или подписаться на меня) на [**Dev.to**](https://dev.to/tiangolo) или [**Medium**](https://medium.com/@tiangolo). |
|||
* Читать другие идеи, статьи и о созданных мной инструментах. |
|||
* Подписаться, чтобы читать, когда я публикую что-то новое. |
|||
|
|||
## Оставить сообщение в X (Twitter) о **FastAPI** { #tweet-about-fastapi } |
|||
|
|||
[Оставьте сообщение в X (Twitter) о **FastAPI**](https://x.com/compose/tweet?text=I'm loving @fastapi because... https://github.com/fastapi/fastapi) и позвольте мне и другим узнать, почему он Вам нравится. 🎉 |
|||
Вы можете подписаться на (редкую) [новостную рассылку **FastAPI и друзья**](newsletter.md), чтобы быть в курсе: |
|||
|
|||
Я люблю узнавать о том, как **FastAPI** используется, что Вам понравилось в нём, в каких проектах/компаниях Вы его используете и т.д. |
|||
* Новости о FastAPI и друзьях 🚀 |
|||
* Руководства 📝 |
|||
* Возможности ✨ |
|||
* Ломающие изменения 🚨 |
|||
* Советы и приёмы ✅ |
|||
|
|||
## Оставить голос за FastAPI { #vote-for-fastapi } |
|||
## Подписаться на FastAPI онлайн { #follow-fastapi-online } |
|||
|
|||
* [Голосуйте за **FastAPI** в Slant](https://www.slant.co/options/34241/~fastapi-review). |
|||
* [Голосуйте за **FastAPI** в AlternativeTo](https://alternativeto.net/software/fastapi/about/). |
|||
* [Расскажите, что Вы используете **FastAPI** на StackShare](https://stackshare.io/pypi-fastapi). |
|||
Вы можете подписаться на **FastAPI** в разных местах: |
|||
|
|||
## Помочь другим с вопросами на GitHub { #help-others-with-questions-in-github } |
|||
* [@fastapi в **X / Twitter**](https://x.com/fastapi) |
|||
* [@fastapi.tiangolo.com в **Bluesky**](https://bsky.app/profile/fastapi.tiangolo.com) |
|||
* [FastAPI в **LinkedIn**](https://www.linkedin.com/company/fastapi/) |
|||
|
|||
Вы можете попробовать помочь другим с их вопросами в: |
|||
## Отметить **FastAPI** звездой на GitHub { #star-fastapi-in-github } |
|||
|
|||
* [GitHub Discussions](https://github.com/fastapi/fastapi/discussions/categories/questions?discussions_q=category%3AQuestions+is%3Aunanswered) |
|||
* [GitHub Issues](https://github.com/fastapi/fastapi/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aquestion+-label%3Aanswered+) |
|||
Вы можете поставить «звезду» FastAPI на GitHub (нажав кнопку со звездой в правом верхнем углу): [https://github.com/fastapi/fastapi](https://github.com/fastapi/fastapi). ⭐️ |
|||
|
|||
Во многих случаях Вы уже можете знать ответы на эти вопросы. 🤓 |
|||
Добавив звезду, другим пользователям будет проще его найти и увидеть, что он уже был полезен другим. |
|||
|
|||
Если Вы много помогаете людям с их вопросами, Вы станете официальным [Экспертом FastAPI](fastapi-people.md#fastapi-experts). 🎉 |
|||
## Следить за релизами в репозитории на GitHub { #watch-the-github-repository-for-releases } |
|||
|
|||
Только помните, самое важное — постарайтесь быть добрыми. Люди приходят со своими разочарованиями и часто задают вопросы не лучшим образом, но постарайтесь, насколько можете, быть доброжелательными. 🤗 |
|||
Вы можете «подписаться» на обновления FastAPI в GitHub (нажав кнопку «Watch» в правом верхнем углу): [https://github.com/fastapi/fastapi](https://github.com/fastapi/fastapi). 👀 |
|||
|
|||
Идея сообщества **FastAPI** — быть доброжелательным и гостеприимным. В то же время не допускайте травлю или неуважительное поведение по отношению к другим. Мы должны заботиться друг о друге. |
|||
Там вы можете выбрать «Releases only». |
|||
|
|||
--- |
|||
Так вы будете получать уведомления (по электронной почте) каждый раз, когда выходит новый релиз (новая версия) **FastAPI** с исправлениями и новыми возможностями. |
|||
|
|||
Как помочь другим с вопросами (в обсуждениях или Issues): |
|||
## Подписаться на автора { #follow-the-author } |
|||
|
|||
### Понять вопрос { #understand-the-question } |
|||
Вы можете подписаться на [меня (Sebastián Ramírez / `tiangolo`)](https://tiangolo.com) в нескольких местах, чтобы узнавать новости о FastAPI и друзьях: |
|||
|
|||
* Убедитесь, что поняли **цель** и кейс использования задающего вопрос. |
|||
* [@tiangolo в **GitHub**](https://github.com/tiangolo). |
|||
* [@tiangolo в **X (Twitter)**](https://x.com/tiangolo) |
|||
* [@tiangolo.com в **Bluesky**](https://bsky.app/profile/tiangolo.com) |
|||
* [@tiangolo в **LinkedIn**](https://www.linkedin.com/in/tiangolo/). |
|||
|
|||
* Затем проверьте, что вопрос (в подавляющем большинстве это вопросы) сформулирован **ясно**. |
|||
## Помогать другим с вопросами на GitHub { #help-others-with-questions-in-github } |
|||
|
|||
* Во многих случаях спрашивают о воображаемом решении пользователя, но может быть решение **получше**. Если Вы лучше поймёте проблему и кейс, сможете предложить **альтернативное решение**. |
|||
Вы можете попробовать помогать другим с их вопросами в [GitHub Discussions](https://github.com/fastapi/fastapi/discussions/categories/questions?discussions_q=category%3AQuestions+is%3Aunanswered). |
|||
|
|||
* Если вопрос непонятен, запросите больше **деталей**. |
|||
Во многих случаях вы уже можете знать ответы на эти вопросы. 🤓 |
|||
|
|||
### Воспроизвести проблему { #reproduce-the-problem } |
|||
Если вы помогаете многим людям с их вопросами, вы станете официальным [Экспертом FastAPI](fastapi-people.md#fastapi-experts). 🎉 |
|||
|
|||
В большинстве случаев и вопросов есть что-то связанное с **исходным кодом** автора. |
|||
Только помните, самое важное — старайтесь быть добрыми. 🤗 |
|||
|
|||
Во многих случаях предоставляют только фрагмент кода, но этого недостаточно, чтобы **воспроизвести проблему**. |
|||
### Как помогать { #how-to-help } |
|||
|
|||
* Попросите предоставить [минимальный воспроизводимый пример](https://stackoverflow.com/help/minimal-reproducible-example), который Вы сможете **скопировать-вставить** и запустить локально, чтобы увидеть ту же ошибку или поведение, или лучше понять их кейс. |
|||
|
|||
* Если чувствуете себя особенно великодушными, можете попытаться **создать такой пример** сами, основываясь только на описании проблемы. Просто помните, что это может занять много времени, и, возможно, сначала лучше попросить уточнить проблему. |
|||
|
|||
### Предложить решение { #suggest-solutions } |
|||
|
|||
* После того как Вы поняли вопрос, Вы можете дать возможный **ответ**. |
|||
|
|||
* Во многих случаях лучше понять **исходную проблему или кейс**, потому что может существовать способ решить её лучше, чем то, что пытаются сделать. |
|||
|
|||
### Попросить закрыть { #ask-to-close } |
|||
|
|||
Если Вам ответили, велика вероятность, что Вы решили их проблему, поздравляю, **Вы — герой**! 🦸 |
|||
|
|||
* Теперь, если проблема решена, можно попросить их: |
|||
* В GitHub Discussions: пометить комментарий как **answer** (ответ). |
|||
* В GitHub Issues: **закрыть** Issue. |
|||
|
|||
## Отслеживать репозиторий на GitHub { #watch-the-github-repository } |
|||
|
|||
Вы можете "отслеживать" FastAPI на GitHub (кликнув по кнопке "watch" наверху справа): [https://github.com/fastapi/fastapi](https://github.com/fastapi/fastapi). 👀 |
|||
|
|||
Если Вы выберете "Watching" вместо "Releases only", то будете получать уведомления, когда кто-либо создаёт новый вопрос или Issue. Вы также можете указать, что хотите получать уведомления только о новых Issues, или обсуждениях, или пулл-реквестах и т.д. |
|||
|
|||
Тогда Вы можете попробовать помочь им с решением этих вопросов. |
|||
Следуйте [руководству по тому, как помогать](https://tiangolo.com/open-source/help/#help-others-with-questions-in-github) здесь. |
|||
|
|||
## Задать вопросы { #ask-questions } |
|||
|
|||
Вы можете [создать новый вопрос](https://github.com/fastapi/fastapi/discussions/new?category=questions) в репозитории GitHub, например: |
|||
Вы можете [создать новый вопрос](https://github.com/fastapi/fastapi/discussions/new?category=questions) в репозитории GitHub, например, чтобы: |
|||
|
|||
* Задать **вопрос** или спросить о **проблеме**. |
|||
* Предложить новую **возможность**. |
|||
|
|||
**Заметка**: если Вы это сделаете, то я попрошу Вас также помогать другим. 😉 |
|||
|
|||
## Проверять пулл-реквесты { #review-pull-requests } |
|||
|
|||
Вы можете помочь мне проверять пулл-реквесты других участников. |
|||
|
|||
И, снова, постарайтесь быть доброжелательными. 🤗 |
|||
|
|||
--- |
|||
|
|||
О том, что нужно иметь в виду и как проверять пулл-реквест: |
|||
|
|||
### Понять проблему { #understand-the-problem } |
|||
|
|||
* Во-первых, убедитесь, что **поняли проблему**, которую пулл-реквест пытается решить. Возможно, это обсуждалось более подробно в GitHub Discussion или Issue. |
|||
## Присоединиться к чату { #join-the-chat } |
|||
|
|||
* Также есть вероятность, что пулл-реквест не нужен, так как проблему можно решить **другим путём**. Тогда Вы можете предложить или спросить об этом. |
|||
Присоединяйтесь к 👥 [чат-серверу в Discord](https://discord.gg/VQjSZaeJmf) 👥 и общайтесь с другими участниками сообщества FastAPI. |
|||
|
|||
### Не переживайте о стиле { #dont-worry-about-style } |
|||
/// tip | Совет |
|||
|
|||
* Не стоит слишком беспокоиться о таких вещах, как стиль сообщений в коммитах — при слиянии я выполню squash и настрою коммит вручную. |
|||
По вопросам — задавайте их в GitHub Discussions, там гораздо выше шанс получить помощь. |
|||
|
|||
* Также не беспокойтесь о правилах стиля, это уже проверяют автоматизированные инструменты. |
|||
|
|||
Если будет нужна какая-то другая стилистика или единообразие, я попрошу об этом напрямую или добавлю поверх свои коммиты с нужными изменениями. |
|||
|
|||
### Проверить код { #check-the-code } |
|||
|
|||
* Проверьте и прочитайте код, посмотрите, логичен ли он, **запустите его локально** и проверьте, действительно ли он решает проблему. |
|||
|
|||
* Затем оставьте **комментарий**, что Вы это сделали, так я пойму, что Вы действительно проверили код. |
|||
|
|||
/// info | Информация |
|||
|
|||
К сожалению, я не могу просто доверять PR-ам только потому, что у них есть несколько одобрений. |
|||
|
|||
Несколько раз было так, что у PR-ов было 3, 5 или больше одобрений, вероятно из-за привлекательного описания, но когда я их проверял, они оказывались сломанными, содержали баги или вовсе не решали заявленную проблему. 😅 |
|||
|
|||
Поэтому очень важно действительно прочитать и запустить код и сообщить мне об этом в комментарии. 🤓 |
|||
|
|||
/// |
|||
|
|||
* Если PR можно упростить, Вы можете попросить об этом, но не нужно быть слишком придирчивым — может быть много субъективных мнений (и у меня тоже 🙈), поэтому лучше сосредоточиться на фундаментальных вещах. |
|||
|
|||
### Тестировать { #tests } |
|||
|
|||
* Помогите мне проверить, что у PR есть **тесты**. |
|||
|
|||
* Проверьте, что тесты **падают** до PR. 🚨 |
|||
|
|||
* Затем проверьте, что тесты **проходят** после PR. ✅ |
|||
|
|||
* Многие PR не имеют тестов — Вы можете **напомнить** добавить тесты или даже **предложить** некоторые тесты сами. Это одна из самых трудозатратных частей, и здесь Вы можете очень помочь. |
|||
|
|||
* Затем добавьте комментарий, что Вы попробовали, чтобы я знал, что Вы это проверили. 🤓 |
|||
|
|||
## Создать пулл-реквест { #create-a-pull-request } |
|||
|
|||
Вы можете [сделать вклад](contributing.md) в исходный код пулл-реквестами, например: |
|||
|
|||
* Исправить опечатку, найденную в документации. |
|||
* Поделиться статьёй, видео или подкастом о FastAPI, которые Вы создали или нашли, [изменив этот файл](https://github.com/fastapi/fastapi/edit/master/docs/en/data/external_links.yml). |
|||
* Убедитесь, что добавили свою ссылку в начало соответствующего раздела. |
|||
* Помочь с [переводом документации](contributing.md#translations) на Ваш язык. |
|||
* Вы также можете проверять переводы, сделанные другими. |
|||
* Предложить новые разделы документации. |
|||
* Исправить существующую проблему/баг. |
|||
* Убедитесь, что добавили тесты. |
|||
* Добавить новую возможность. |
|||
* Убедитесь, что добавили тесты. |
|||
* Убедитесь, что добавили документацию, если это уместно. |
|||
|
|||
## Помочь поддерживать FastAPI { #help-maintain-fastapi } |
|||
|
|||
Помогите мне поддерживать **FastAPI**! 🤓 |
|||
|
|||
Предстоит ещё много работы, и, по большей части, **ВЫ** можете её сделать. |
|||
|
|||
Основные задачи, которые Вы можете выполнить прямо сейчас: |
|||
|
|||
* [Помочь другим с вопросами на GitHub](#help-others-with-questions-in-github) (смотрите секцию выше). |
|||
* [Проверять пулл-реквесты](#review-pull-requests) (смотрите секцию выше). |
|||
|
|||
Именно эти две задачи **забирают больше всего времени**. Это основная работа по поддержке FastAPI. |
|||
|
|||
Если Вы можете помочь мне с этим, **Вы помогаете поддерживать FastAPI** и делаете так, чтобы он продолжал **развиваться быстрее и лучше**. 🚀 |
|||
|
|||
## Подключиться к чату { #join-the-chat } |
|||
|
|||
Подключайтесь к 👥 [серверу чата в Discord](https://discord.gg/VQjSZaeJmf) 👥 и общайтесь с другими участниками сообщества FastAPI. |
|||
|
|||
/// tip | Подсказка |
|||
|
|||
По вопросам — задавайте их в [GitHub Discussions](https://github.com/fastapi/fastapi/discussions/new?category=questions), так гораздо выше шанс, что Вы получите помощь от [Экспертов FastAPI](fastapi-people.md#fastapi-experts). |
|||
|
|||
Используйте чат только для прочих общих бесед. |
|||
Используйте чат только для прочих общих разговоров. |
|||
|
|||
/// |
|||
|
|||
### Не используйте чат для вопросов { #dont-use-the-chat-for-questions } |
|||
|
|||
Имейте в виду, что в чатах, благодаря "свободному общению", легко задать вопросы, которые слишком общие и на которые сложнее ответить, поэтому Вы можете не получить ответы. |
|||
|
|||
На GitHub шаблон поможет Вам правильно сформулировать вопрос, чтобы Вам было легче получить хороший ответ или даже решить проблему самостоятельно ещё до того, как спросите. И на GitHub я могу следить за тем, чтобы всегда отвечать на всё, даже если это занимает время. А с чатами я не могу сделать этого лично. 😅 |
|||
|
|||
Кроме того, переписка в чатах хуже ищется, чем на GitHub, поэтому вопросы и ответы могут теряться среди остальных сообщений. И только те, что на GitHub, учитываются для получения лычки [Эксперт FastAPI](fastapi-people.md#fastapi-experts), так что вероятнее всего Вы получите больше внимания именно на GitHub. |
|||
|
|||
С другой стороны, в чатах тысячи пользователей, так что почти всегда есть шанс найти там кого-то для разговора. 😄 |
|||
|
|||
## Спонсировать автора { #sponsor-the-author } |
|||
|
|||
Если Ваш **продукт/компания** зависят от **FastAPI** или связаны с ним и Вы хотите донести до пользователей информацию о себе, Вы можете спонсировать автора (меня) через [GitHub Sponsors](https://github.com/sponsors/tiangolo). В зависимости от уровня поддержки Вы можете получить дополнительные бонусы, например, бейдж в документации. 🎁 |
|||
Имейте в виду, что в чатах, благодаря «свободному общению», в чатах легко задавать слишком общие вопросы, на которые сложнее ответить, поэтому вы можете не получить ответов. |
|||
|
|||
--- |
|||
На GitHub шаблон подскажет, как сформулировать правильный вопрос, чтобы вам было проще получить хороший ответ или даже решить проблему самостоятельно ещё до того, как спросить. |
|||
|
|||
Спасибо! 🚀 |
|||
Кроме того, переписки в чатах хуже ищутся, чем на GitHub, и быстро теряются. |
|||
|
|||
Loading…
Reference in new issue