[개선] 스뮤스뮤 개선사항 list up을 위한 준비

[NOTA2]

• 개선사항은 크게 5가지로 잡는다.
• 이슈 생성시 [카테고리] 형식으로 앞쪽에 달아주기 바람.
• 숫자는 우선도

카테고리

1. [불량처리]
   • 제대로 동작하지 않는 기능들을 정상화
   • 불량 처리 도중 예외처리가 필요한 경우에는 해당 이슈를 epic으로 등록
     • 이렇게 되면 불량처리 이슈는 2개 만들어 져야함 (epic으로 등록된 불량처리, 실제 불량처리)
     • 총 이슈는 3개가 됨(epic으로 등록된 불량처리, 실제 불량처리, 예외처리)
2. [예외처리]
   • 서버가 닫히지 않아야 함
   • 해당 예외처리가 불량처리 도중 필요한 과정이라면 epic으로 등록된 불량처리 이슈의 하위로 등록
3. [기능폐지]
   • 필요없는 기능 폐지의 경우 [기능폐지 토론] 이슈 생성 후 협의가 완료 되면 [기능폐지] 이슈를 생성하고 제거
4. [기능개선]
   • 리팩토링 (코드 개선) 역시 포함
   • 더 나은 기능을 제공할 수 있다면 이슈 생성 후 방법을 설명
5. [추가기능]
   • 말 그대로 추가기능

이슈생성 주의사항

• 개선사항에 대한 모든 것을 list up 한 후 이를 각각 이슈로 등록한다.
• list up의 경우 우선도와 상관없이 이슈등록
• 이후 각 이슈에 대해 Assignees(담당자), Labels를 설정하기
• 이슈 처리시 Pipelines 꼭 수정하기

이슈 처리 예시

• 미백관 학식이 제대로 크롤링 되지 않는 경우

1. issue 등록

• issue : [불량처리] 미백관 학식 크롤링 불량 개선
  • 내용은 알아서 채워놓고 (현상, 이유, 해결방안)
  • 만약 해당 이슈에 대한 번호가 3 일경우

2. branch 생성

• 모든 branch는 develop을 기준으로 생성한다.
• branch 이름 형식은 => feature/smusmu-3
• epic 브랜치의 경우 => feature/smusmu-epic-3
  • epic 이슈의 하위 이슈인 경우 에픽 브랜치를 기준으로 생성해야한다.

3. 개선 후 commit

• commit 시 기본적으로 #이슈번호 이슈제목 {특이사항}를 기본으로 한다.
• 예)
  • #3 [불량처리] 미백관 학식 크롤링 불량 개선
  • [불량처리] 미백관 학식 크롤링 불량 개선 - 공백 제거
  • [불량처리] 미백관 학식 크롤링 불량 개선 - 예외상황 추가
  • [불량처리] 미백관 학식 크롤링 불량 개선 - 코드리뷰 반영

4. commit 후 push

• push 할땐 당연히 개발한 branch로
• 이후 PR을 올린다.

5. PR

• PR시 상대방을 반드시 리뷰어로 등록
• 해당 PR과 관련된 이슈 connetion 하고 내용에서 꼭 언급하기
• PR에 어떤 부분을 고쳤는지 적기
• 리뷰를 받은 것만 스스로 merge하기
• merge 후 remote에 있는 branch는 삭제!
• PR 예시 PR 제목 : [불량처리] 미백관 학식 크롤링 불량 개선

  3 에 대한 PR입니다.

  이러이렇게 해서 이러이렇게 바꿈...

6. dev 서버에서 테스트

• 위의 내용은 당연히 local에서 개발하는 것
  1. github에서 merge > dev 서버에서 develop을 pull(수동) > build(수동)
  2. 잘 작동이 된다면 develop branch를 master branch로 merge
  3. 이후 real 서버에서 master를 pull
  4. real 서버에서 문제가 없다면 해당 이슈를 close

[wkghd1223]

확인했습니다.

[NOTA2]

협업시 참고하면 좋을 글 https://velog.io/@cos/Github에서-협업하는-방법

[NOTA2]

개발 방법 자체는 git-flow를 따르므로 관련 자료들을 해당 코멘트에 추가한다.

http://danielkummer.github.io/git-flow-cheatsheet/index.ko_KR.html

[wkghd1223]

@NOTA2 테스트