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

Conversation

leeeyubin
Copy link
Member

@leeeyubin leeeyubin commented Nov 1, 2024

협업 컨벤션을 작성하였습니다:)

@leeeyubin leeeyubin self-assigned this Nov 1, 2024
Copy link
Member

@giovannijunseokim giovannijunseokim left a comment

Choose a reason for hiding this comment

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

고생하셨습니다 ~!


- 개인 개발 브랜치

> 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.

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

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.

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

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

Choose a reason for hiding this comment

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

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

Comment on lines +95 to +100
### PR title

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

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 제목은 브렌치 이름 확정나고 나서 다시 얘기해봐요:)

Comment on lines 109 to 113
### 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 하기


- 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를 사용하지 않는 이유는 무엇인가요 !?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants