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

Collaboration Guide #1

Open
kingyong9169 opened this issue Apr 4, 2022 · 0 comments
Open

Collaboration Guide #1

kingyong9169 opened this issue Apr 4, 2022 · 0 comments
Assignees
Labels
📚 Share 공유할 내용을 논의합니다.

Comments

@kingyong9169
Copy link
Contributor

kingyong9169 commented Apr 4, 2022

파일 구조

├── 김동용
│   ├── 1988 토마토.cpp
│   ├── 498 사칙연산.java
│   └── ...소스 파일들...
├── 이동우
├── 이승현
├── 이진원
├── ...스터디원 성함..
└── 엄예진

Issues(Document)

  1. 이슈 제목은 한글, 영어 상관없습니다!
  2. 이슈는 질문사항, 공유할 내용이 있을 때 작성합니다.
  3. 마크다운 형식에 맞게 이슈탭에 작성합니다.
  4. 이슈를 작성할때는 이슈 템플릿에 맞게 작성하고 이슈를 담당할 Assignees(담당자)와 Labels(Question, Share 등)를 설정합니다.
  5. 논의가 종료된 이슈는 close합니다.
  6. 이슈는 필요에 맞게 자유롭게 많이 많이 작성할수록 좋습니다.

Branch

  1. 브랜치는 main 브랜치를 메인 브랜치로 사용합니다.
  2. 브랜치는 이슈사항을 먼저 이슈탭에 작성한 뒤에 생성합니다.
  3. 브랜치 생성규칙은 {주차}/{이름}와 같은 형태로 작성합니다. ex) 1주차/최문형

ref.
[Git] 브랜칭 전략 : Git, Github, GitLab flow

Commit

  1. 커밋 메시지의 subject는 [{주차}] : {이름} - {문제번호 문제이름 티어} (#문제집issue번호)로 작성합니다.
    e.g. [1주차] : 최문형 - 1998 토마토 Gold5 (#10)(콜론(:) 앞, 뒤로 띄어쓰기 주의 ⚠️)
  2. 재시도, 리펙토링 등으로 커밋을 날리게 될 경우,
    [1주차] : 최문형 - 1988 토마토 Gold5 (#10) refactoring으로 적어야 합니다.
  3. 부연 설명이 필요한 경우 body에 작성합니다.(한글가능)

Pull Request

  1. Pull Request 는 정해진 템플릿에 맞춰 작성하고 제목에 한글, 영어 모두 사용가능합니다. [{주차}] {이름} ex) [1주차] 최문형
  2. Assignees(담당자)와 Labels(Question, Share 등)를 설정합니다.
  3. 코드리뷰를 반영하고 한 개 이상의 approve를 받은 후에 그룹장squash-merge합니다.
  4. 간단한 변경사항은 self-approve 라벨을 붙이고 스스로 merge 할 수 있습니다.

Contribution Guide

  1. 브랜치 생성
  2. 코드 작성
  3. git add 및 commit
  4. (3),(4)를 반복하고 완료되면 git push
  5. Pull Request 작성
  6. 코드리뷰 요청(일정 시간동안 approve가 없는경우)
  7. 코드리뷰 반영
  8. Merge
  9. Delete Branch를 클릭하여 브랜치 삭제
    질문, 공유 등 내용은 이슈를 남기기!!
@kingyong9169 kingyong9169 added the 📚 Share 공유할 내용을 논의합니다. label Apr 5, 2022
@kingyong9169 kingyong9169 self-assigned this Apr 5, 2022
@alirz-pixel alirz-pixel self-assigned this May 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 Share 공유할 내용을 논의합니다.
Projects
None yet
Development

No branches or pull requests

2 participants