[1 주차 회고_AOS] 현업에서 제대로 된 깃헙 활용 + 요구 사항에 맞는 개발을 위한 ReadMe 작성의 중요성

우선 무엇보다!!! 회고 글을 잘 써야 한다는 부담을 버리자. 중요한 것은 글을 예쁘고 멋지게 쓰고 공유하는 것이 아니라 나 스스로가 부족했던 부분들을 찾고 그 부분들을 보완하는 것이기 때문에!! 글은 매우 가볍게 핵심들만 쓰자. 결국 글도 나중에 refactoring하면 되는 것 아닌가!!ㅎㅎㅎ

 

1주 차 과제를 간신히 제출하고 나서 1주 차 공통 피드백을 받았는데, 그 피드백들이 정말 실제 코딩할 때 크게 필요하고 의미가 많은 부분들이라고 느껴져서 무척이나 새로웠다. 그중에서도 디테일이 빛나는 부분들이 있었는데 일부만 가져오면 다음과 같다.

 

1. 커밋 메세지를 유의미하게 작성하라.

이 부분은 2주차 피드백에서도 보다 더 디테일하게 컨벤션과 함께 제시가 되는데, 무척이나 와닿는 부분이었다. 그전까지는 사실 깃 자체가 익숙하지 않기도 했고 어떻게 커밋하는 게 좋은 지에 대한 생각이 적었는데, 이번 기회에 실질적으로 커밋을 적극 활용하는 방법을 알 수 있게 되어서 무척 많이 배운다는 느낌이 있었다.

 

2. git 커밋할 때 불필요한 파일들은 제거하라.

예를 들어 .class 파일, IntelliJ IDEA의 .idea  폴더, Eclipse의 .metadata 폴더 등은 자동으로 생성되는 파일들이므로 이를 굳이 커밋할 필요가 없다니. 사실 상식적으로 너무나 당연한 부분이었지만 제대로 고려하지 못했다.......

 

3. Pull Request 전에 맞는 브랜치인지 확인하라.

이건...... 제대로 요구 조건들을 제대로 안 본 나를 탓해야 하는...... 따로 branch를 파서 하라고 했는데 아무 생각 없이 main에서 해버렸다...... 이건 제대로 팀플로 개발을 안 해본 내 모습이 너무 단적으로 드러난 상황이라 부끄럼이 컸던.......

 

4. 공백도 컨벤션이다.

사실, 공백 등을 고려한 가독성을 고려한 코딩은 전혀 하지 못했다. 과제를 풀고 테스트 케이스를 통과하는 데에 급했기 때문에...... 앞으로는 Intellij가 제공하는 자동 정렬 기능을 적극 활용하자......

IntelliJ IDEA: ⌥⌘L, Ctrl+Alt+L

 

---

1주 차 제출한 것 자체를 돌이켜보며 자체 피드백을 추가로 한 부분들은 다음과 같다.

주로 본 분들은 PR 요청을 하셨던 분들

(1. https://github.com/woowacourse-precourse/kotlin-onboarding/pull/124

 2. https://github.com/woowacourse-precourse/kotlin-onboarding/pull/152/)

 

1. 커밋할 때 다음과 같이 커밋하자

예) [FEAT] Problem 1 구현, [REFACTOR] Problem 5 toList() 삭제, list 자료형 생략, [COMMENT] Problem3 기능 목록 추가

 

2. 불변 인자들의 경우 미리 const val + 대문자를 쓰자.

예) 1번에서, const val ERROR = -1, const val SAME = 0 식으로~!

 

3. 전반적으로 객체 지향에 맞게 코딩을 하자.

최대한 depth를 줄이고 개별 모듈을 각각 하나의 기능만 하는 모듈들로 구분하는 것이 필요하다.

 

4. ReadMe에 필요한 기능 구현 요소들을 잘 쓰자.

 

5. 해쉬 맵, 리스트, 셋을 잘 쓰자.....