weekly-study

매주 학습한 내용을 자유롭게 공유하는 공간

📌 규칙

• 매주 일요일 자정까지 pr 올리기 (그다음주 월요일에 자동 merge)
  • pr에는 꼭 1개 이상의 스터디 파일이 포함되어 있어야 함

벌금 제도

• 기준 : pr 여부 및 pr에 포함된 스터디 파일
• pr을 올리지 않은 경우 5,000원
• 모임통장으로 입금

📎 참여방법

1. "깃허브아이디/study"로 된 branch를 새로 만든다.

   // branch 생성과 변경을 함꼐
   git checkout -b "브랜치명"
   
   // branch 변경
   git checkout "브랜치명"
   

2. 만들어진 branch에 본인 깃ID로 된 폴더를 생성한다.

3. 생성된 폴더에 자신의 스터디 파일을 업로드 한다. (폴더명에 콜론":" 안됩니다!)

4. 이때 commit 규칙을 지키도록한다!

5. "main" branch로 Pull Request를 한다. (매주 주말에 Merge 예정)

6. 다른 사람들의 PR을 보고 자유롭게 리뷰를 한다.

7. 주의!! 기존 폴더를 지우면 안됩니다!! 개인 폴더 내부만 수정해주세요 :)

❗️ 스터디 파일 이름 규칙

• 자유롭게 작성
• 폴더명 또는 파일명에 콜론 ":", "?", "!" 등 특수문자 안됩니다 :D
• url 첨부해야하는 경우, txt 파일에 url 작성

🙏 commit 규칙

• commit 메세지: [정리방식] 학습한 주제
• description: url 주소 (option)
• 터미널에서 작성법:
  git commit -m "[BOJ] Hello World / 브론즈5 / 1분" -m "https://velog.io/"

정리방식별 작성법 통일

• [PDF] - pdf 파일
• [MD] - 마크다운
• [URL] - 링크 첨부 (블로그 등에 정리한 경우)

🙏 pr 규칙

pr 제목

[2025년 1월 둘째주/아이디명] 학습한 주제명

예시 ) [2025년 1월 둘째주/julia8024] SwiftData 기초

⭐️ pr 생성 방법

• 스터디 파일을 본인 브랜치에 커밋 후 pr을 생성해서 올려주세요.
• pr 템플릿 활용하여 내용을 작성해주세요.
• pr 생성하실 때는 라벨을 추가해주세요.

⭐️ pr merge 후 할 일

• main 브랜치의 변경사항을 본인 브랜치에 업데이트해주세요

$git fetch --all
$git merge origin/main
// 커밋 생략 가능
$git push [브랜치명]

💗 하면 좋은 것들

💬 리뷰

• 매주 월요일 pr merge 전까지 다른 사람들의 pr에 리뷰를 할 수 있어요.
• 칭찬, 질문, 다른 풀이방법 공유 등 자유롭게 남겨요. (무조건 비판 X)

🙋🏻‍♂️ 질문

• Issue를 생성하여 자유롭게 질문해요.
• Issue 생성하실 때는 라벨을 추가해주세요.