Feature 구현 Guide (7/23/2024)

[ytaek]

FEATURES

ENGINE

1. 생성형 AI를 이용하여, commit 10개를 3줄로 요약해보기
2. author별 PR, Review 통계 수집 모듈: Octopus API(https://github.com/topics/octopus-api) 활용

VIEW

1. Line Chart, Bar chart
2. 데이터는 자율적으로 선택 가능 (날씨, 주식? 등등 공공데이터 json/csv활용 추천)

---

스펙

• Typescript로 합니다.
• README.md에는 본인 소개 및 코드에 대한 설명(자유롭게. 설계, 요구사항, feature, 사용법 등등)을 넣습니다.
• D3의 경우 TS로 짜기에 난이도가 조금 있다고 생각이 들면 우선 ts-ignore 처리하셔도 됩니다 (연습과제 때만).
• 혹시나 여유가 된다면 Test Case를 만들어주세요 (jest 이용).

---

과제 관련해서

• 속한 팀에서 하나를 고릅니다.
• 과제 2개를 하는 것보다는 코드 리뷰를 많이 하는 걸 권장합니다.
• [project명] / [id] / 폴더 안에 본인의 코드를 넣어주세요.
• 마지막 날에 코드를 왕창 다 올리지 마시고, 쪼개서 자주 올려주세요.
• Issue, Wiki 모두 자유롭게 활용가능합니다. 단 프로젝트 이름으로 말머리를 달아주세요. (예: [icicle] 적합한 색상은 무엇일까요?)

그리고,

• 팀 혹은 과제별로 논의해서 같이 설계를 해도 되고, 개별로 해도 됩니다.
• 리뷰를 많이 많이 신경써주세요.
• feature practice 없이 Contribution을 바로 시작해도 좋습니다. (Discord에 먼저 알려주세요!)

---

리뷰

• 리뷰는 팀 상관없이 모두 상호 리뷰 가능합니다.
• 리뷰어의 Approval이 2개 이상 있어야 PR의 Merge가 가능하게 셋팅해놓았습니다.
• 불필요하게 보일 수는 있겠지만, 그래도 커멘트의 서두를 칭찬으로 만들어봅시다 :-).
• 질문 적극 권장합니다. 토론의 장으로 번지는 것 환영합니다.

Pull Request

• PR Description을 최대한 상세하게 써주세요.
• Commit Message는 말머리를 가집니다 (https://www.conventionalcommits.org/en/v1.0.0/).
• fix, feat, chore, refactor, 등의 header를 사용하시면 됩니다. (예-> feat: line 그리는 모듈)
• 개인 repo에 fork 한 다음에 main에 올려주세요. 현재 repo는 main 브랜치만 운영하겠습니다.
• 리뷰어를 위해서라도 가급적 적은 단위로 올려주세요. 200줄 내외를 권장(필수는 아님)합니다.
• 리팩토링이 아닌 새로운 feature인데 loc(line of code)가 크면, 리뷰어가 힘들어 합니다.
• 개발중이더라도, 올리는 코드가 build fail이 나면 안됩니다.

실습의 목적이 아래와 같음을 인지하시고, 화이팅입니다!

• GitHub과 친해지기
• 팀원들과 친해지기
• 코드리뷰에 익숙해지기
• Githru 맛보기