contributing.md

Contributing Rules

✨ How To

1. 본인 이름의 브랜치를 생성합니다.
2. 매주 일요일 자정 전까지 최소 5개 질문에 대한 답을 정리한 후,main 브랜치로 pull request 를 생성합니다.
3. 이때 모두가 다른 사람들이 open 한 pull request 에 꼬리 질문 형식으로 comment 를 답니다.

🙌 Convention

Pull Request (답변)

# 양식 지켜주세요 !
[해당주차] [질문 번호] (이름)

• 답변 PR 오픈 시에는 본인 이름의 브랜치를 사용합니다.
  • PR 방향 : 본인 브랜치 -> main
• 답변용 PR 제목 예시 : [Feb w5] [Network(#1,#2,#3), Database(#1, #2)] 엄소은
• Labels 는 answer 를 선택합니다.
• 본인의 답변 내용에 대해 질문이 있다면 PR 을 열고 코멘트에 남겨주세요 !

Pull Request (질문)

# 양식 지켜주세요 !
[주제] [추가한 질문 번호] 질문 추가

• 질문 추가시에는 질문만 있는 question 브랜치를 사용합니다. 🚨
  • PR 방향 : question -> main
• 질문 추가용 PR 제목 예시 : [Network] [#26,#27] 질문 추가
• 질문 추가는 2명의 리뷰어를 지정합니다. 리뷰어 2명 이상의 승인 시 main 브랜치에 머지 합니다.
  • 리뷰어 추가는 PR 열었을 때 옆에 Assignees 에서 지정할 수 있습니다.
• Labels 는 question 를 선택합니다.
• 본 스터디의 목적이 양질의 질문들을 추가하는 것도 목표이므로, 활발하게 질문들을 추가해주세요. 질문은 단편적인 지식을 묻는 내용이 아닌, 하나의 주제에 대해 다각도로 생각해볼 수 있도록 만들어주세요.

Commit

# 양식 지켜주세요 !

# 답변 처음 작성
[주제] [질문 번호] 답변

# 답변 수정
[주제] [질문 번호] 답변 수정

# 질문 추가
[주제] [질문 번호] 질문 추가

• Commit 예시
  • [Network] #1 답변
  • [Network] #1 답변 수정
  • [Network] #27 질문 추가