Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat : add github convention #3

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions Github/github_convention.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
# Github Convention
유어슈 안드로이드 팀 협업 컨벤션

## Branch

- 개인 개발 브랜치

> feature/{nickname}/{feature-name}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이슈 번호는 명시할 필요 딱히 없을까요 !?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

저희가 개발을 할 때 작은 규모의 작업은 이슈를 파지 않고 진행하는 경우도 있어서 따로 명시해두진 않았어요!
이슈를 파는 경우에 대해서도 한 번 더 논의해봐야겠네요..!

>
예시) feature/comet/home

- 공용 개발 브랜치

> feature/{feature-name}
>
예시) feature/home


## Commit
### Commit title
> <타입> : <내용>
- 내용은 최대 50글자 정도로만 입력
- 1 Action 1 Commit

### Commit type
- chore: 자잘한 수정
- docs: README나 WIKI 등의 문서 개정
- feat: 새로운 기능 구현
- fix: 버그, 오류 해결
- refactor: 리팩토링

## Issue
### Issue template
- bug report
```
---
name: Bug Report
about: 버그 리포트
title: "[bug]"
labels: fix
assignees: ''

---

**어떤 버그인가요?**
> 어떤 버그인지 간결하게 설명해주세요

**어떤 상황에서 발생한 버그인가요?**
- Device: [e.g. Android Emulator]
- OS: [e.g. Android 13]
- 숨쉴때 버전 [e.g. debug/release 1.3.5]
Comment on lines +48 to +51
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

네트워크 환경에 대한 체크도 필요할 것 같습니다!


**버그 재현 방법**
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**스크린샷(선택)**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

스크린샷 또는 영상이 좋을 것 같아요!
되도록이면 영상인 경우가 버그 파악하기 쉬울 것 같습니다!


**이슈 체크리스트**
> 사이즈가 S 미만인 이슈는 따로 등록되지 않아도 괜찮아요
- [ ] 노션 이슈의 속성 설정하기 (우선순위, 사이즈, 태그(선택))
- [ ] 태스크를 시작하기 전, 노션에 예상 마감일자를 등록해주세요
```
- feature issue
```
---
name: Feature Issue Template
about: 기능 추가, 개선
title: "[feat]"
labels: feat
assignees: ''

---

**어떤 기능 또는 개선인가요?**
> 추가하려는 기능 또는 개선에 대해 간결하게 설명해주세요

**참고 자료(선택)**
> 피그마, 노션, 슬랙 링크 등

**작업 상세 내용**
- [ ] TODO
- [ ] TODO

**체크리스트**
> 사이즈가 S 미만인 이슈는 따로 등록되지 않아도 괜찮아요
- [ ] 노션 이슈의 속성 설정하기 (우선순위, 사이즈, 태그(선택))
- [ ] 태스크를 시작하기 전, 노션에 예상 마감일자를 등록해주세요
```

## Pull Request

### PR title

> [<레포 이름>-#<이슈 번호>] <내용>
>
- <레포 이름> : Soomsil, YDS

Comment on lines +95 to +100
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR이 결국 한 레포에 종속되는데, 레포 이름은 빼도 되지 않을까요 !?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

추가적으로 브랜치 이름의 컨벤션을 잘 만들었다면, New Pull Request 만들었을 때 나오는 이름 그대로 사용해도 되지 않을까 싶어요!

매번 만들기 전에 다른 PR 제목을 복사해서 붙여넣고 수정하는 방식으로 지었는데, 꽤 귀찮더라구요.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

레포 이름 대신 작업 유형(feature, chore 등)을 넣어도 괜찮을 것 같네요!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

보통 PR을 생성하면 항상 브렌치 이름으로 제목이 생성되는 걸까요? (이 부분에 대해서 자세하게 봐본 적이 없네요,,)
PR 제목은 브렌치 이름 확정나고 나서 다시 얘기해봐요:)

### PR label
- chore: 코드 수정, 내부 파일 수정
- docs: README나 WIKI 등의 문서 개정
- feat: 새로운 기능 구현
- fix: 버그, 오류 해결
- help: draft PR시 사용
- refactor: 리팩토링

### PR review rule

- 기존 코드 수정 → 해당 코드 오너
- 새로운 파일 추가 → 랜덤지정
- approve 2개 이상 받으면 알아서 merge 하기
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-> 의 오른쪽에 있는 사람이 리뷰어 대상자 인가요?
그렇다면 다음과 같이 수정해도 될 것 같아요.

Suggested change
### PR review rule
- 기존 코드 수정 → 해당 코드 오너
- 새로운 파일 추가 → 랜덤지정
- approve 2개 이상 받으면 알아서 merge 하기
### PR review rule
- 리뷰어 지정
- 기존 코드 수정 → 해당 코드 오너
- 새로운 파일 추가 → 랜덤지정
- approve 2개 이상 받으면 알아서 merge 하기


### PR template

```
## Summary
<!-- 무슨 이유로 코드를 변경했는지 -->
<!-- 테스트 계획 또는 완료 사항 -->

## Describe your changes
<!-- 변경 또는 추가된 코드, 관련 스크린샷 -->

## Issue

- close #{Issue number}

## To reviewers
<!-- 어떤 위험이나 장애가 발견되었는지 -->
<!-- 어떤 부분에 리뷰어가 집중하면 좋을지 -->

<!-- android-maintainer(안드로이드팀 액티브 멤버)를 멘션해요.
리뷰어를 여러 명 등록할 수 없어서 이렇게 하고 있어요.
알림을 보내고 싶지 않다면 아래 줄을 지워주세요. -->
@yourssu/android-maintainer
```

### PR merge

- feature → develop : 스쿼시(squash) merge
- develop → main : 일반(with merge commit) merge
- hotfix → main : 일반 merge
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 경우엔 squash merge를 사용하지 않는 이유는 무엇인가요 !?