Перейти до змісту

Допоможіть FastAPI - отримайте допомогу

🌐 Переклад ШІ та людьми

Цей переклад виконано ШІ під керівництвом людей. 🤝

Можливі помилки через неправильне розуміння початкового змісту або неприродні формулювання тощо. 🤖

Ви можете покращити цей переклад, допомігши нам краще спрямовувати AI LLM.

Англійська версія

Вам подобається FastAPI?

Хочете допомогти FastAPI, іншим користувачам та автору?

Або ви хочете отримати допомогу щодо FastAPI?

Є дуже прості способи допомогти (деякі потребують лише одного-двох кліків).

І є кілька способів отримати допомогу.

Підпишіться на розсилку

Ви можете підписатися на (нечасту) розсилку FastAPI and friends, щоб бути в курсі:

  • Новин про FastAPI та друзів 🚀
  • Посібників 📝
  • Можливостей ✨
  • Несумісних змін 🚨
  • Порад і трюків ✅

Стежте за FastAPI в X (Twitter)

Стежте за @fastapi в X (Twitter), щоб отримувати найсвіжіші новини про FastAPI. 🐦

Додайте зірочку FastAPI на GitHub

Ви можете «поставити зірочку» FastAPI на GitHub (натиснувши кнопку зірочки у верхньому правому куті): https://github.com/fastapi/fastapi. ⭐️

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

Стежте за випусками в репозиторії GitHub

Ви можете «спостерігати» за FastAPI на GitHub (натиснувши кнопку «watch» у верхньому правому куті): https://github.com/fastapi/fastapi. 👀

Там ви можете вибрати «Releases only».

Зробивши це, ви отримуватимете сповіщення (на вашу електронну пошту) щоразу, коли вийде новий реліз (нова версія) FastAPI з виправленнями помилок і новими можливостями.

Зв'яжіться з автором

Ви можете зв'язатися зі мною (Sebastián Ramírez / tiangolo), автором.

Ви можете:

  • Стежити за мною на GitHub.
    • Подивитися інші Open Source-проєкти, які я створив і які можуть вам допомогти.
    • Стежити, щоб бачити, коли я створюю новий Open Source-проєкт.
  • Стежити за мною в X (Twitter) або Mastodon.
    • Розкажіть мені, як ви використовуєте FastAPI (мені дуже приємно це чути).
    • Дізнаватися, коли я роблю оголошення або випускаю нові інструменти.
    • Також ви можете стежити за @fastapi в X (Twitter) (окремий акаунт).
  • Стежити за мною в LinkedIn.
    • Дізнаватися, коли я роблю оголошення або випускаю нові інструменти (хоча X (Twitter) я використовую частіше 🤷‍♂).
  • Читати, що я пишу (або стежити за мною) на Dev.to або Medium.
    • Читати інші ідеї, статті та про інструменти, які я створив.
    • Стежити, щоб читати нове, коли я щось публікую.

Твітніть про FastAPI

Твітніть про FastAPI і дайте мені та іншим знати, чому він вам подобається. 🎉

Мені дуже подобається дізнаватися, як використовують FastAPI, що вам у ньому сподобалося, у якому проєкті/компанії ви його застосовуєте тощо.

Голосуйте за FastAPI

Допомагайте іншим з питаннями на GitHub

Ви можете спробувати допомагати іншим з їхніми питаннями у:

У багатьох випадках ви вже можете знати відповідь на ці питання. 🤓

Якщо ви багато допомагаєте людям із їхніми питаннями, ви станете офіційним Експертом FastAPI. 🎉

Пам'ятайте, найважливіше: намагайтеся бути добрими. Люди приходять зі своєю фрустрацією і часто питають не найкращим чином, але постарайтеся бути якомога доброзичливішими. 🤗

Ідея в тому, щоб спільнота FastAPI була доброзичливою та гостинною. Водночас не терпіть булінг чи неповажну поведінку щодо інших. Ми маємо піклуватися одне про одного.

Ось як допомагати іншим із питаннями (у discussions або issues):

Зрозумійте питання

  • Перевірте, чи розумієте ви мету та варіант використання людини, яка питає.

  • Потім перевірте, чи чітке саме питання (переважна більшість — це питання).

  • Часто запит стосується уявного рішення користувача, але може бути краще. Якщо ви краще зрозумієте проблему та варіант використання, зможете запропонувати кращу альтернативу.

  • Якщо ви не розумієте питання, попросіть більше подробиць.

Відтворіть проблему

У більшості випадків і запитань мова йде про оригінальний код людини.

Часто вони наводять лише фрагмент коду, але цього недостатньо, щоб відтворити проблему.

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

  • Якщо ви дуже щедрі, можете спробувати створити такий приклад самостійно, лише на основі опису проблеми. Просто майте на увазі, що це може зайняти багато часу, і краще спочатку попросити їх уточнити проблему.

Запропонуйте рішення

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

  • Часто краще зрозуміти їхню первинну проблему або варіант використання, адже може бути кращий спосіб її вирішити, ніж те, що вони намагаються зробити.

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

Якщо вони відповіли, дуже ймовірно, що ви розв'язали їхню проблему. Вітаю, ви герой! 🦸

  • Тепер, якщо це вирішило їхню проблему, ви можете попросити:

    • У GitHub Discussions: позначити коментар як відповідь.
    • У GitHub Issues: закрити issue.

Стежте за репозиторієм GitHub

Ви можете «спостерігати» за FastAPI на GitHub (натиснувши кнопку «watch» у верхньому правому куті): https://github.com/fastapi/fastapi. 👀

Якщо вибрати «Watching» замість «Releases only», ви отримуватимете сповіщення, коли хтось створює нове issue або питання. Ви також можете вказати, що хочете отримувати сповіщення лише про нові issues, або discussions, або PR тощо.

Тоді ви зможете спробувати допомогти їм вирішити ці питання.

Ставте питання

Ви можете створити нове питання у репозиторії GitHub, наприклад, щоб:

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

Примітка: якщо ви це зробите, я попрошу вас також допомагати іншим. 😉

Переглядайте запити на витяг

Ви можете допомогти мені переглядати запити на витяг інших.

І знову, будь ласка, намагайтеся бути якомога доброзичливішими. 🤗

Ось що слід пам'ятати і як переглядати запит на витяг:

Зрозумійте проблему

  • Спочатку переконайтеся, що ви розумієте проблему, яку намагається вирішити запит на витяг. Може бути довша дискусія у GitHub Discussion або issue.

  • Також є велика ймовірність, що запит на витяг насправді не потрібен, бо проблему можна розв'язати іншим способом. Тоді ви можете про це запропонувати або запитати.

Не переймайтеся стилем

  • Не надто хвилюйтеся про стиль повідомлень фіксацій, я зроблю squash and merge, налаштувавши фіксацію вручну.

  • Також не переймайтеся правилами стилю, вже є автоматизовані інструменти, що це перевіряють.

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

Перевірте код

  • Перегляньте та прочитайте код, оцініть, чи він має сенс, запустіть його локально і перевірте, чи справді він розв'язує проблему.

  • Потім залиште коментар, що ви це зробили, так я знатиму, що ви справді перевірили.

Інформація

На жаль, я не можу просто довіряти PR, які мають кілька схвалень.

Бувало не раз, що PR мали 3, 5 або більше схвалень, мабуть тому, що опис привабливий, але коли я перевіряв PR, вони виявлялися зламаними, мали помилку або не розв'язували заявлену проблему. 😅

Тож дуже важливо, щоб ви справді прочитали і запустили код та повідомили в коментарях, що ви це зробили. 🤓

  • Якщо PR можна якось спростити, ви можете про це попросити, але немає потреби бути надто прискіпливими, адже може бути багато суб'єктивних точок зору (і в мене також є своя 🙈), тож краще зосередитися на фундаментальних речах.

Тести

  • Допоможіть перевірити, що PR має тести.

  • Переконайтеся, що тести падають до PR. 🚨

  • Потім перевірте, що тести проходять після PR. ✅

  • Багато PRів не мають тестів, ви можете нагадати додати тести або навіть запропонувати деякі тести самі. Це одна з речей, яка найбільше забирає часу, і ви дуже допоможете.

  • Потім також прокоментуйте, що саме ви спробували, так я знатиму, що ви це перевірили. 🤓

Створіть запит на витяг

Ви можете зробити внесок у вихідний код із запитами на витяг, наприклад:

  • Щоб виправити описку, знайдену в документації.
  • Щоб поділитися статтею, відео або подкастом про FastAPI, який ви створили або знайшли, відредагувавши цей файл.
    • Обов'язково додайте ваше посилання на початок відповідного розділу.
  • Щоб допомогти перекласти документацію вашою мовою.
    • Ви також можете допомогти з переглядом перекладів, створених іншими.
  • Щоб запропонувати нові розділи документації.
  • Щоб виправити наявну проблему/помилку.
    • Обов'язково додайте тести.
  • Щоб додати нову можливість.
    • Обов'язково додайте тести.
    • Обов'язково додайте документацію, якщо це доречно.

Допоможіть підтримувати FastAPI

Допоможіть мені підтримувати FastAPI! 🤓

Роботи багато, і більшу її частину можете зробити ВИ.

Основні завдання, які ви можете виконувати вже зараз:

Ці два завдання найбільше споживають час. Це основна робота з підтримки FastAPI.

Якщо ви можете допомогти мені з цим, ви допомагаєте підтримувати FastAPI і гарантуєте, що він рухатиметься швидше й краще. 🚀

Долучайтеся до чату

Долучайтеся до 👥 серверу чату Discord 👥 і спілкуйтеся з іншими в спільноті FastAPI.

Порада

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

Використовуйте чат лише для інших загальних розмов.

Не використовуйте чат для запитань

Майте на увазі, що оскільки чати дозволяють більше «вільної розмови», легко ставити надто загальні питання, на які складніше відповісти, тож ви можете не отримати відповідей.

У GitHub шаблон підкаже вам, як написати правильне питання, щоб ви легше отримали хорошу відповідь, або навіть вирішили проблему самостійно ще до запиту. І в GitHub я можу гарантувати, що завжди на все відповім, навіть якщо це займе трохи часу. Особисто я не можу робити це в чатах. 😅

Розмови в чатах також не так просто шукати, як у GitHub, тож питання та відповіді можуть загубитися. І лише ті, що в GitHub, зараховуються, щоб стати Експертом FastAPI, тож швидше за все ви отримаєте більше уваги саме в GitHub.

З іншого боку, у чатах є тисячі користувачів, тож дуже ймовірно, що ви майже завжди знайдете там співрозмовника. 😄

Якщо ваш продукт/компанія залежить від FastAPI або пов'язана з ним і ви хочете охопити його користувачів, ви можете спонсорувати автора (мене) через GitHub sponsors. Залежно від рівня ви можете отримати додаткові переваги, наприклад значок у документації. 🎁

Дякую! 🚀