Notice
Recent Posts
Recent Comments
Link
«   2025/03   »
1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31
Tags
more
Archives
Today
Total
관리 메뉴

임선오

Contributors 되기! [ FASTAPI 문서번역(Translation) ] 본문

Contributor

Contributors 되기! [ FASTAPI 문서번역(Translation) ]

chol_rang 2024. 11. 26. 21:16

오늘은 python언어의 큰 라이브러리인 FASTAPI의 Contributor가 되기위해!

노오오력을 해볼 예정입니다.

 

가장먼저 해야할 것은 할만한? 문서 찾기입니다. 

 

기존에 내가 공부했었던 Django와는 다르게 FASTAPI는 한국어 번역이 부진은 아니고 살짝 아쉬운 경향이 있는것 같더라구요.

 

 

그래서! 먼저 Fastapi의 github인 https://github.com/fastapi/fastapi

 

GitHub - fastapi/fastapi: FastAPI framework, high performance, easy to learn, fast to code, ready for production

FastAPI framework, high performance, easy to learn, fast to code, ready for production - fastapi/fastapi

github.com

로 이동해서 본인의 레포지토리로 'Fork'를 떠와야 합니다.

(물론 문서번역의경우 바로 진행해도 되지만! 추후 문서번역이 아닌 코드를 하게 될 경우를 대비하여 Fork를 떠오는것을 추천받았습니다.)

 

저는 이미 Fork를 떠온 상태이기 때문에 이렇게 뜨지만 

원래는 저 이미지가 아니라... 가져올거냐고 다시한번 되묻는 확인창이 뜰겁니다.

 

이렇게 본인의 레포지토리를 뒤적뒤적 해보면 위의 사진처럼 본인프로필이 박힌 fastapi를 받아오는데 성공했으면 시작이 순조롭게 됩니다! 

 

그 뒤에는 fork를 떠왔으면 vscord에서 뭐시기냐...

git clone을 해야겠죠? (하는 방법 모르시면 GPT로..세상 친절하게 알려줍니다) 

 

git clone을 하면 

이렇게 창이 뜰텐데 위에 en/docs랑 ko/docs랑 비교해서 en에 있는것이 ko에 없으면 번역하시면 됩니다! 

물론 다른것들도 많이 참고해야겠지만
참고할 수 있는 참조사이트 

https://www.flowdas.com/pages/python-docs-ko.html

 

파이썬 한국어 번역 — flowdas

파이썬 한국어 번역 https://docs.python.org 사이트의 한국어 번역이 진행중입니다. 다음은 관련 링크들입니다. https://python.flowdas.com/ - 번역의 주석판이 출판되는 장소입니다. 예제 코드에 포함된 주

www.flowdas.com

https://dev.to/ceb10n/helping-fastapi-how-to-contribute-to-docs-translations-44a7?fbclid=IwY2xjawGIiJRleHRuA2FlbQIxMQABHVhJXypGDqAf5d6kfaaav9e1V86OMHro448L3PGb52gBWLrEom5pJBWREA_aem_MDQccWTWtgF6pDyKEGeClw

 

Helping FastAPI: How to contribute to docs translations

One of the great features of FastAPI is its great documentation 👏. But wouldn't it be better if more...

dev.to

https://fastapi.tiangolo.com/ko/tutorial/first-steps/#3

 

첫걸음 - FastAPI

FastAPI framework, high performance, easy to learn, fast to code, ready for production

fastapi.tiangolo.com

https://fastapi.tiangolo.com/contributing/#existing-language

 

Development - Contributing - FastAPI

FastAPI framework, high performance, easy to learn, fast to code, ready for production

fastapi.tiangolo.com

등등 참조할수 있는 사이트를 확인 후 시작하시면 됩니다. 

이번에 제가 번역해볼 문서는

 

testing-dependenises.md 라는 문서 입니다.

가장먼저 en에는 있지만 ko에는 없는 문서를 찾은 후 

fastapi의 pull requests의 들어가서 

새롭게 pull requests를 할 문서가 생성중인지 병합이 되진않았는지 누가 먼저 하고있는지 체크를 한 뒤에 

번역을 시작하면 됩니다. 

 

여기서 중요한 내용은 무작정 번역만 한다고 되는게 아니라 

제가 위에 적어놓았던 참조사이트를 참조하여! python 한글 번역, 마크다운언어 유지 등 필수적인 부분을 체크 후 pull requests에 올리면 됩니다.

 

저는 없는것을 확인 후 

vscord에 들어와서 브런치를 변경했습니다. 

어떠한 형식으로 브런치명을 하는지까지 위에 참조사이트에 나와있으니 꼭 필독 후 진행하시기 바랍니다.

 

번역이 끝난 모습이다.

그리고

 

git add , commit, push도 위의 참조사이트를 참조 후 진행 했습니다. 

그럼fastapi github에 들어가보면

 

이렇게 뜰것이다! 
초록색 버튼을 눌러서 

Pull requests를 진행하면 된다! 

 

 

ㅡ러

그럼 이렇게 화면이 보일것인데 여기부터는 다른사람들이 확인 후 댓글을 달아주면 겸허히 받아들이고 기다리다보면 merge가 될 것이다. (사실 안될수도.._) 

 

댓글이 달리거나 추 후 merge가 된다면 다시 블로그에 올리도록 하겠음.