fastapi/docs/pt/docs/help-fastapi.md

Ajude o FastAPI - Obtenha ajuda

Você gosta do FastAPI?

Você gostaria de ajudar o FastAPI, outras pessoas usuárias e o autor?

Ou você gostaria de obter ajuda com o FastAPI?

Há maneiras muito simples de ajudar (várias envolvem apenas um ou dois cliques).

E também há várias formas de obter ajuda.

Assine a newsletter

Você pode assinar a (infrequente) newsletter do FastAPI and friends{.internal-link target=_blank} para ficar por dentro de:

• Notícias sobre FastAPI e amigos 🚀
• Tutoriais 📝
• Funcionalidades ✨
• Mudanças incompatíveis 🚨
• Dicas e truques ✅

Siga o FastAPI no X (Twitter)

Siga @fastapi no X (Twitter) para receber as últimas notícias sobre o FastAPI. 🐦

Dê uma estrela ao FastAPI no GitHub

Você pode “marcar com estrela” o FastAPI no GitHub (clicando no botão de estrela no canto superior direito): https://github.com/fastapi/fastapi. ⭐️

Ao adicionar uma estrela, outras pessoas conseguirão encontrá-lo com mais facilidade e verão que já foi útil para muita gente.

Acompanhe o repositório no GitHub para lançamentos

Você pode “acompanhar” (watch) o FastAPI no GitHub (clicando no botão “watch” no canto superior direito): https://github.com/fastapi/fastapi. 👀

Lá você pode selecionar “Apenas lançamentos” (Releases only).

Fazendo isso, você receberá notificações (no seu email) sempre que houver um novo lançamento (uma nova versão) do FastAPI com correções de bugs e novas funcionalidades.

Conecte-se com o autor

Você pode se conectar comigo (Sebastián Ramírez / tiangolo), o autor.

Você pode:

• Me seguir no GitHub.
  • Ver outros projetos Open Source que criei e que podem ajudar você.
  • Me seguir para saber quando eu criar um novo projeto Open Source.
• Me seguir no X (Twitter) ou no Mastodon.
  • Me contar como você usa o FastAPI (adoro saber disso).
  • Ficar sabendo quando eu fizer anúncios ou lançar novas ferramentas.
  • Você também pode seguir @fastapi no X (Twitter) (uma conta separada).
• Me seguir no LinkedIn.
  • Ver quando eu fizer anúncios ou lançar novas ferramentas (embora eu use mais o X (Twitter) 🤷‍♂).
• Ler o que escrevo (ou me seguir) no Dev.to ou no Medium.
  • Ler outras ideias, artigos e conhecer ferramentas que criei.
  • Me seguir para ver quando eu publicar algo novo.

Tweet sobre o FastAPI

Tweet sobre o FastAPI e conte para mim e para outras pessoas por que você gosta dele. 🎉

Eu adoro saber como o FastAPI está sendo usado, o que você tem curtido nele, em qual projeto/empresa você o utiliza, etc.

Vote no FastAPI

• Vote no FastAPI no Slant.
• Vote no FastAPI no AlternativeTo.
• Diga que você usa o FastAPI no StackShare.

Ajude outras pessoas com perguntas no GitHub

Você pode tentar ajudar outras pessoas com suas perguntas em:

• GitHub Discussions
• GitHub Issues

Em muitos casos você já pode saber a resposta para aquelas perguntas. 🤓

Se você estiver ajudando muitas pessoas com suas perguntas, você se tornará um(a) Especialista em FastAPI{.internal-link target=_blank} oficial. 🎉

Apenas lembre-se, o ponto mais importante é: tente ser gentil. As pessoas chegam com frustrações e, em muitos casos, não perguntam da melhor forma, mas tente ao máximo ser gentil. 🤗

A ideia é que a comunidade do FastAPI seja gentil e acolhedora. Ao mesmo tempo, não aceite bullying ou comportamentos desrespeitosos com outras pessoas. Temos que cuidar uns dos outros.

---

Veja como ajudar outras pessoas com perguntas (em discussions ou issues):

Entenda a pergunta

• Verifique se você consegue entender qual é o objetivo e o caso de uso de quem está perguntando.

• Depois verifique se a pergunta (a grande maioria são perguntas) está clara.

• Em muitos casos a pergunta feita é sobre uma solução imaginada pela pessoa usuária, mas pode haver uma solução melhor. Se você entender melhor o problema e o caso de uso, pode sugerir uma solução alternativa melhor.

• Se você não entender a pergunta, peça mais detalhes.

Reproduza o problema

Na maioria dos casos e na maioria das perguntas há algo relacionado ao código original da pessoa.

Em muitos casos ela só copia um fragmento do código, mas isso não é suficiente para reproduzir o problema.

• Você pode pedir que forneçam um exemplo mínimo, reproduzível, que você possa copiar e colar e executar localmente para ver o mesmo erro ou comportamento que elas estão vendo, ou para entender melhor o caso de uso.

• Se você estiver muito generoso(a), pode tentar criar um exemplo assim você mesmo(a), apenas com base na descrição do problema. Só tenha em mente que isso pode levar bastante tempo e pode ser melhor pedir primeiro que esclareçam o problema.

Sugira soluções

• Depois de conseguir entender a pergunta, você pode dar uma possível resposta.

• Em muitos casos, é melhor entender o problema subjacente ou caso de uso, pois pode haver uma forma melhor de resolver do que aquilo que estão tentando fazer.

Peça para encerrar

Se a pessoa responder, há uma grande chance de você ter resolvido o problema, parabéns, você é um(a) herói(na)! 🦸

• Agora, se isso resolveu o problema, você pode pedir para:

  • No GitHub Discussions: marcar o comentário como a resposta.
  • No GitHub Issues: encerrar a issue.

Acompanhe o repositório do GitHub

Você pode “acompanhar” (watch) o FastAPI no GitHub (clicando no botão “watch” no canto superior direito): https://github.com/fastapi/fastapi. 👀

Se você selecionar “Acompanhando” (Watching) em vez de “Apenas lançamentos” (Releases only), receberá notificações quando alguém criar uma nova issue ou pergunta. Você também pode especificar que quer ser notificado(a) apenas sobre novas issues, ou discussions, ou PRs, etc.

Assim você pode tentar ajudar a resolver essas questões.

Faça perguntas

Você pode criar uma nova pergunta no repositório do GitHub, por exemplo para:

• Fazer uma pergunta ou perguntar sobre um problema.
• Sugerir uma nova funcionalidade.

Nota: se você fizer isso, então vou pedir que você também ajude outras pessoas. 😉

Revise Pull Requests

Você pode me ajudar revisando pull requests de outras pessoas.

Novamente, por favor tente ao máximo ser gentil. 🤗

---

Veja o que ter em mente e como revisar um pull request:

Entenda o problema

• Primeiro, garanta que você entendeu o problema que o pull request tenta resolver. Pode haver uma discussão mais longa em uma Discussion ou issue do GitHub.

• Também há uma boa chance de o pull request não ser realmente necessário porque o problema pode ser resolvido de uma forma diferente. Aí você pode sugerir ou perguntar sobre isso.

Não se preocupe com estilo

• Não se preocupe muito com coisas como estilos de mensagens de commit, eu vou fazer squash e merge personalizando o commit manualmente.

• Também não se preocupe com regras de estilo, já há ferramentas automatizadas verificando isso.

E se houver qualquer outra necessidade de estilo ou consistência, vou pedir diretamente, ou vou adicionar commits por cima com as mudanças necessárias.

Verifique o código

• Verifique e leia o código, veja se faz sentido, execute localmente e veja se realmente resolve o problema.

• Depois comente dizendo que você fez isso, é assim que saberei que você realmente verificou.

/// info | Informação

Infelizmente, eu não posso simplesmente confiar em PRs que têm várias aprovações.

Já aconteceu várias vezes de haver PRs com 3, 5 ou mais aprovações, provavelmente porque a descrição é atraente, mas quando eu verifico os PRs, eles estão quebrados, têm um bug, ou não resolvem o problema que afirmam resolver. 😅

Por isso, é realmente importante que você leia e execute o código, e me avise nos comentários que você fez isso. 🤓

///

• Se o PR puder ser simplificado de alguma forma, você pode pedir isso, mas não há necessidade de ser exigente demais, pode haver muitos pontos de vista subjetivos (e eu terei o meu também 🙈), então é melhor focar nas coisas fundamentais.

Testes

• Me ajude a verificar se o PR tem testes.

• Verifique se os testes falham antes do PR. 🚨

• Depois verifique se os testes passam após o PR. ✅

• Muitos PRs não têm testes, você pode lembrar a pessoa de adicionar testes, ou até sugerir alguns testes você mesmo(a). Essa é uma das coisas que consomem mais tempo e você pode ajudar muito com isso.

• Depois também comente o que você testou, assim vou saber que você verificou. 🤓

Crie um Pull Request

Você pode contribuir{.internal-link target=_blank} com o código-fonte fazendo Pull Requests, por exemplo:

• Para corrigir um erro de digitação que você encontrou na documentação.
• Para compartilhar um artigo, vídeo ou podcast que você criou ou encontrou sobre o FastAPI, editando este arquivo.
  • Garanta que você adicione seu link no início da seção correspondente.
• Para ajudar a traduzir a documentação{.internal-link target=_blank} para seu idioma.
  • Você também pode ajudar a revisar as traduções criadas por outras pessoas.
• Para propor novas seções de documentação.
• Para corrigir uma issue/bug existente.
  • Garanta que você adicione testes.
• Para adicionar uma nova funcionalidade.
  • Garanta que você adicione testes.
  • Garanta que você adicione documentação se for relevante.

Ajude a manter o FastAPI

Ajude-me a manter o FastAPI! 🤓

Há muito trabalho a fazer e, para a maior parte dele, VOCÊ pode ajudar.

As principais tarefas que você pode fazer agora são:

• Ajudar outras pessoas com perguntas no GitHub{.internal-link target=_blank} (veja a seção acima).
• Revisar Pull Requests{.internal-link target=_blank} (veja a seção acima).

Essas duas tarefas são as que mais consomem tempo. Esse é o principal trabalho de manter o FastAPI.

Se você puder me ajudar com isso, você está me ajudando a manter o FastAPI e garantindo que ele continue avançando mais rápido e melhor. 🚀

Entre no chat

Entre no 👥 servidor de chat do Discord 👥 e converse com outras pessoas da comunidade FastAPI.

/// tip | Dica

Para perguntas, faça-as no GitHub Discussions, há uma chance muito maior de você receber ajuda pelos Especialistas em FastAPI{.internal-link target=_blank}.

Use o chat apenas para outras conversas gerais.

///

Não use o chat para perguntas

Tenha em mente que, como os chats permitem uma “conversa mais livre”, é fácil fazer perguntas muito gerais e mais difíceis de responder, então você pode acabar não recebendo respostas.

No GitHub, o template vai orientar você a escrever a pergunta certa para que você consiga obter uma boa resposta com mais facilidade, ou até resolver o problema sozinho(a) antes de perguntar. E no GitHub eu consigo garantir que sempre vou responder tudo, mesmo que leve algum tempo. Eu pessoalmente não consigo fazer isso com os sistemas de chat. 😅

As conversas nos sistemas de chat também não são tão fáceis de pesquisar quanto no GitHub, então perguntas e respostas podem se perder na conversa. E somente as que estão no GitHub contam para você se tornar um(a) Especialista em FastAPI{.internal-link target=_blank}, então é bem provável que você receba mais atenção no GitHub.

Por outro lado, há milhares de usuários nos sistemas de chat, então há uma grande chance de você encontrar alguém para conversar por lá quase o tempo todo. 😄

Patrocine o autor

Se o seu produto/empresa depende de ou está relacionado ao FastAPI e você quer alcançar suas pessoas usuárias, você pode patrocinar o autor (eu) através do GitHub sponsors. Dependendo do nível, você pode obter benefícios extras, como um selo na documentação. 🎁

---

Obrigado! 🚀