FastAPI 지원 - 도움 받기¶
FastAPI 가 마음에 드시나요?
FastAPI, 다른 사용자, 개발자를 응원하고 싶으신가요?
혹은 FastAPI 에 대해 도움이 필요하신가요?
아주 간단하게 응원할 수 있습니다 (몇 번의 클릭만으로).
또한 도움을 받을 수 있는 방법도 몇 가지 있습니다.
뉴스레터 구독¶
FastAPI and friends 뉴스레터를 구독하여 최신 정보를 유지할 수 있습니다:
- FastAPI and friends에 대한 뉴스 🚀
- 가이드 📝
- 기능 ✨
- 획기적인 변화 🚨
- 팁과 요령 ✅
트위터에서 FastAPI 팔로우하기¶
Twitter의 @fastapi를 팔로우하여 FastAPI 에 대한 최신 뉴스를 얻을 수 있습니다. 🐦
Star FastAPI in GitHub¶
GitHub에서 FastAPI에 "star"를 붙일 수 있습니다 (오른쪽 상단의 star 버튼을 클릭): https://github.com/fastapi/fastapi. ⭐️
스타를 늘림으로써, 다른 사용자들이 좀 더 쉽게 찾을 수 있고, 많은 사람들에게 유용한 것임을 나타낼 수 있습니다.
GitHub 저장소에서 릴리즈 확인¶
GitHub에서 FastAPI를 "watch"할 수 있습니다 (오른쪽 상단 watch 버튼을 클릭): https://github.com/fastapi/fastapi. 👀
여기서 "Releases only"을 선택할 수 있습니다.
이렇게하면, FastAPI 의 버그 수정 및 새로운 기능의 구현 등의 새로운 자료 (최신 버전)이 있을 때마다 (이메일) 통지를 받을 수 있습니다.
개발자와의 연결¶
개발자(Sebastián Ramírez / tiangolo
)와 연락을 취할 수 있습니다.
여러분은 할 수 있습니다:
- GitHub에서 팔로우하기..
- 당신에게 도움이 될 저의 다른 오픈소스 프로젝트를 확인하십시오.
- 새로운 오픈소스 프로젝트를 만들었을 때 확인하려면 팔로우 하십시오.
- Twitter 또는 Mastodon에서 팔로우하기.
- FastAPI의 사용 용도를 알려주세요 (그것을 듣는 것을 좋아합니다).
- 발표나 새로운 툴 출시 소식을 받아보십시오.
- Twitter의 @fastapi를 팔로우 (별도 계정에서) 할 수 있습니다.
- LinkedIn에서 팔로우하기..
- 새로운 툴의 발표나 출시 소식을 받아보십시오. (단, Twitter를 더 자주 사용합니다 🤷♂).
- Dev.to 또는 Medium에서 제가 작성한 내용을 읽어 보십시오 (또는 팔로우).
- 다른 기사나 아이디어들을 읽고, 제가 만들어왔던 툴에 대해서도 읽으십시오.
- 새로운 기사를 읽기 위해 팔로우 하십시오.
FastAPI에 대한 트윗¶
FastAPI에 대해 트윗 하고 FastAPI가 마음에 드는 이유를 알려주세요. 🎉
FastAPI가 어떻게 사용되고 있는지, 어떤 점이 마음에 들었는지, 어떤 프로젝트/회사에서 사용하고 있는지 등에 대해 듣고 싶습니다.
FastAPI에 투표하기¶
GitHub의 이슈로 다른사람 돕기¶
다른 사람들의 질문에 도움을 줄 수 있습니다:
많은 경우, 여러분은 이미 그 질문에 대한 답을 알고 있을 수도 있습니다. 🤓
만약 많은 사람들의 문제를 도와준다면, 공식적인 FastAPI 전문가 가 될 것입니다. 🎉
가장 중요한 점은: 친절하려고 노력하는 것입니다. 사람들은 좌절감을 안고 오며, 많은 경우 최선의 방식으로 질문하지 않을 수도 있습니다. 하지만 최대한 친절하게 대하려고 노력하세요. 🤗
FastAPI 커뮤니티의 목표는 친절하고 환영하는 것입니다. 동시에, 괴롭힘이나 무례한 행동을 받아들이지 마세요. 우리는 서로를 돌봐야 합니다.
다른 사람들의 질문 (디스커션 또는 이슈에서) 해결을 도울 수 있는 방법은 다음과 같습니다.
질문 이해하기¶
-
질문하는 사람이 가진 목적과 사용 사례를 이해할 수 있는지 확인하세요.
-
질문 (대부분은 질문입니다)이 명확한지 확인하세요.
-
많은 경우, 사용자가 가정한 해결책에 대한 질문을 하지만, 더 좋은 해결책이 있을 수 있습니다. 문제와 사용 사례를 더 잘 이해하면 더 나은 대안적인 해결책을 제안할 수 있습니다.
-
질문을 이해할 수 없다면, 더 자세한 정보를 요청하세요.
문제 재현하기¶
대부분의 경우, 질문은 질문자의 원본 코드와 관련이 있습니다.
많은 경우, 코드의 일부만 복사해서 올리지만, 그것만으로는 문제를 재현하기에 충분하지 않습니다.
-
질문자에게 최소한의 재현 가능한 예제를 제공해달라고 요청하세요. 이렇게 하면 코드를 복사-붙여넣기하여 직접 실행하고, 동일한 오류나 동작을 확인하거나 사용 사례를 더 잘 이해할 수 있습니다.
-
너그러운 마음이 든다면, 문제 설명만을 기반으로 직접 예제를 만들어볼 수도 있습니다. 하지만, 이는 시간이 많이 걸릴 수 있으므로, 먼저 질문을 명확히 해달라고 요청하는 것이 좋습니다.
해결책 제안하기¶
-
질문을 충분히 이해한 후에는 가능한 답변을 제공할 수 있습니다.
-
많은 경우, 질문자의 근본적인 문제나 사용 사례를 이해하는 것이 중요합니다. 그들이 시도하는 방법보다 더 나은 해결책이 있을 수 있기 때문입니다.
해결 요청하기¶
질문자가 답변을 확인하고 나면, 당신이 문제를 해결했을 가능성이 높습니다. 축하합니다, 당신은 영웅입니다! 🦸
-
이제 문제를 해결했다면, 질문자에게 다음을 요청할 수 있습니다.
- GitHub 디스커션에서: 댓글을 답변으로 표시하도록 요청하세요.
- GitHub 이슈에서: 이슈를 닫아달라고 요청하세요.
GitHub 저장소 보기¶
GitHub에서 FastAPI를 "watch"할 수 있습니다 (오른쪽 상단 watch 버튼을 클릭): https://github.com/fastapi/fastapi. 👀
"Releases only" 대신 "Watching"을 선택하면, 새로운 이슈나 질문이 생성될 때 알림을 받을 수 있습니다. 또한, 특정하게 새로운 이슈, 디스커션, PR 등만 알림 받도록 설정할 수도 있습니다.
그런 다음 이런 이슈들을 해결 할 수 있도록 도움을 줄 수 있습니다.
이슈 생성하기¶
GitHub 저장소에 새로운 이슈 생성을 할 수 있습니다, 예를들면 다음과 같습니다:
- 질문을 하거나 문제에 대해 질문합니다.
- 새로운 기능을 제안 합니다.
참고: 만약 이슈를 생성한다면, 저는 여러분에게 다른 사람들을 도와달라고 부탁할 것입니다. 😉
Pull Requests 리뷰하기¶
다른 사람들의 pull request를 리뷰하는 데 도움을 줄 수 있습니다.
다시 한번 말하지만, 최대한 친절하게 리뷰해 주세요. 🤗
Pull Rrquest를 리뷰할 때 고려해야 할 사항과 방법은 다음과 같습니다:
문제 이해하기¶
-
먼저, 해당 pull request가 해결하려는 문제를 이해하는지 확인하세요. GitHub 디스커션 또는 이슈에서 더 긴 논의가 있었을 수도 있습니다.
-
Pull request가 필요하지 않을 가능성도 있습니다. 다른 방식으로 문제를 해결할 수 있다면, 그 방법을 제안하거나 질문할 수 있습니다.
스타일에 너무 신경 쓰지 않기¶
-
커밋 메시지 스타일 같은 것에 너무 신경 쓰지 않아도 됩니다. 저는 직접 커밋을 수정하여 squash and merge를 수행할 것입니다.
-
코드 스타일 규칙도 걱정할 필요 없습니다. 이미 자동화된 도구들이 이를 검사하고 있습니다.
스타일이나 일관성 관련 요청이 필요한 경우, 제가 직접 요청하거나 필요한 변경 사항을 추가 커밋으로 수정할 것입니다.
코드 확인하기¶
-
코드를 읽고, 논리적으로 타당한지 확인한 후 로컬에서 실행하여 문제가 해결되는지 확인하세요.
-
그런 다음, 확인했다고 댓글을 남겨 주세요. 그래야 제가 검토했음을 알 수 있습니다.
Info
불행히도, 제가 단순히 여러 개의 승인만으로 PR을 신뢰할 수는 없습니다.
3개, 5개 이상의 승인이 달린 PR이 실제로는 깨져 있거나, 버그가 있거나, 주장하는 문제를 해결하지 못하는 경우가 여러 번 있었습니다. 😅
따라서, 정말로 코드를 읽고 실행한 뒤, 댓글로 확인 내용을 남겨 주는 것이 매우 중요합니다. 🤓
- PR을 더 단순하게 만들 수 있다면 그렇게 요청할 수 있지만, 너무 까다로울 필요는 없습니다. 주관적인 견해가 많이 있을 수 있기 때문입니다 (그리고 저도 제 견해가 있을 거예요 🙈). 따라서 핵심적인 부분에 집중하는 것이 좋습니다.
테스트¶
-
PR에 테스트가 포함되어 있는지 확인하는 데 도움을 주세요.
-
PR을 적용하기 전에 테스트가 실패하는지 확인하세요. 🚨
-
PR을 적용한 후 테스트가 통과하는지 확인하세요. ✅
-
많은 PR에는 테스트가 없습니다. 테스트를 추가하도록 상기시켜줄 수도 있고, 직접 테스트를 제안할 수도 있습니다. 이는 시간이 많이 소요되는 부분 중 하나이며, 그 부분을 많이 도와줄 수 있습니다.
-
그리고 시도한 내용을 댓글로 남겨주세요. 그러면 제가 확인했다는 걸 알 수 있습니다. 🤓
Pull Request를 만드십시오¶
Pull Requests를 이용하여 소스코드에 컨트리뷰트 할 수 있습니다. 예를 들면 다음과 같습니다:
- 문서에서 발견한 오타를 수정할 때.
- FastAPI 관련 문서, 비디오 또는 팟캐스트를 작성했거나 발견하여 이 파일을 편집하여 공유할 때.
- 해당 섹션의 시작 부분에 링크를 추가해야 합니다.
- 당신의 언어로 문서 번역하는데 기여할 때.
- 다른 사람이 작성한 번역을 검토하는 것도 도울 수 있습니다.
- 새로운 문서의 섹션을 제안할 때.
- 기존 문제/버그를 수정할 때.
- 테스트를 반드시 추가해야 합니다.
- 새로운 feature를 추가할 때.
- 테스트를 반드시 추가해야 합니다.
- 관련 문서가 필요하다면 반드시 추가해야 합니다.
FastAPI 유지 관리에 도움 주기¶
FastAPI의 유지 관리를 도와주세요! 🤓
할 일이 많고, 그 중 대부분은 여러분이 할 수 있습니다.
지금 할 수 있는 주요 작업은:
- GitHub에서 다른 사람들의 질문에 도움 주기 (위의 섹션을 참조하세요).
- Pull Request 리뷰하기 (위의 섹션을 참조하세요).
이 두 작업이 가장 많은 시간을 소모하는 일입니다. 그것이 FastAPI 유지 관리의 주요 작업입니다.
이 작업을 도와주신다면, FastAPI 유지 관리에 도움을 주는 것이며 그것이 더 빠르고 더 잘 발전하는 것을 보장하는 것입니다. 🚀
채팅에 참여하십시오¶
👥 디스코드 채팅 서버 👥 에 가입하고 FastAPI 커뮤니티에서 다른 사람들과 어울리세요.
질문을 위해 채팅을 사용하지 마십시오¶
채팅은 더 많은 "자유로운 대화"를 허용하기 때문에, 너무 일반적인 질문이나 대답하기 어려운 질문을 쉽게 질문을 할 수 있으므로, 답변을 받지 못할 수 있습니다.
GitHub 이슈에서의 템플릿은 올바른 질문을 작성하도록 안내하여 더 쉽게 좋은 답변을 얻거나 질문하기 전에 스스로 문제를 해결할 수도 있습니다. 그리고 GitHub에서는 시간이 조금 걸리더라도 항상 모든 것에 답할 수 있습니다. 채팅 시스템에서는 개인적으로 그렇게 할 수 없습니다. 😅
채팅 시스템에서의 대화 또한 GitHub에서 처럼 쉽게 검색할 수 없기 때문에 대화 중에 질문과 답변이 손실될 수 있습니다. 그리고 GitHub 이슈에 있는 것만 FastAPI Expert가 되는 것으로 간주되므로, GitHub 이슈에서 더 많은 관심을 받을 것입니다.
반면, 채팅 시스템에는 수천 명의 사용자가 있기 때문에, 거의 항상 대화 상대를 찾을 가능성이 높습니다. 😄
개발자 스폰서가 되십시오¶
GitHub 스폰서 를 통해 개발자를 경제적으로 지원할 수 있습니다.
감사하다는 말로 커피를 ☕️ 한잔 사줄 수 있습니다. 😄
또한 FastAPI의 실버 또는 골드 스폰서가 될 수 있습니다. 🏅🎉
FastAPI를 강화하는 도구의 스폰서가 되십시오¶
문서에서 보았듯이, FastAPI는 Starlette과 Pydantic 라는 거인의 어깨에 타고 있습니다.
다음의 스폰서가 될 수 있습니다
감사합니다! 🚀