같이 Tutorial 문서화 및 리뷰에 참여하고 싶으신 분을 모집합니다. #2
Description
배경
sqlalchemy는 DB와 연동된 작업을 할 때 많이 쓰이는 도구입니다.
저는 필요에 따라 구글링해서 써보기는 했으나, 뭔가 제대로 안다고 느낀적이 없었네요.
그러다 빈번히 작업이 막히거나, 구글링하는데 시간을 쏟곤 했습니다.
파이썬으로 개발을 하는 사람이라면 sqlalchemy에 대해 한 번쯤은 제대로 알고가야하지 않나 싶은 생각이 점점 들었는데요.
생각만 하다가 이번 기회를 통해 한 번 제대로 공부해야겠단 결심이 섰습니다.
현재의 sqlalchemy 문서는 굉장히 딱딱한데요. 초보자가 보기에 이것저것 잘 모르는 용어들과 내용이 마구 튀어나오곤 합니다.
이에, 공식 문서를 정독하며 한글화 + 좀 더 쉽게 읽을 수 있도록 만드는 작업을 해보고 싶습니다.
혼자 하는거보단, 같이 하는게 더 동기부여되고 성취감이 있을거 같아, 같이 해보실분을 모집해봅니다.
목표
일단 첫 번째 목표는 sqlalchemy 공식 홈페이지에 있는 튜토리얼 문서를 읽고 정리하는 것입니다.
정리는 한글로 하고, 초보자도 친숙히 읽기 쉽도록 적당히 정리하는 것이 목표입니다.
계획
튜토리얼은 다음과 같은 목차로 되어있습니다.
- Tutorial Overview
- Establishing Connectivity - the Engine
- Working with Transactions and the DBAPI
- Working with Database Metadata
- Working with Data
- Data Manipulation with the ORM
- Working with Related Objects
- Further Reading
튜토리얼인 만큼 목차 순서도 중요하다고 생각합니다.
따라서 매 주마다 한 명이 목차요소 하나를 정리합니다.
예를 들면, 현재 1~3은 제가 이미 정리를 해놨으므로(여기서 확인하실 수 있습니다.), 다음 순서에 해당하는 분이 4번 내용을 정리해주시면 됩니다.
그 다음주 순서에 해당하는 분은 5번이 되겠구요. 이렇게 8번까지 정리하게 되고, 총 5주 동안 진행되겠네요.
이 순서의 간격을 '매주'가 아니라 다르게 할지, 담당 내용의 범위는 적정한지는 논의해보면 좋을듯 합니다.
매번 올라오는 글은 PR을 통해 공유되고, 멤버들이 리뷰해줍니다.
예를 들어, 내용을 읽다가 이 내용이 이해가 가지 않는다는지 (그렇다면 추가 설명 내용을 붙여주면 좋겠죠)
비문이 있다든가, 단어가 혼용되었다든가 등의 내용이 리뷰에 담기게 됩니다.
PR 제목, 커밋 메시지 규칙, Merge 방법은 제가 추후에 가이드하겠습니다.
덧붙이는 말
지금은 대충 범위와 목표만 잡은 상태입니다.
활동 방법 등 실행가능한 더 좋은 아이디어가 있으시면 말씀해주세요.
참여하고 싶으신 분은 아래 코멘트 달아주시면 되겠습니다!
궁금하신 것도 있으시면 적어주세요~!