Skip to content

today-we-learned-korea/Notice

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

Today We Learned - Oragnization 규칙

Today I Learned의 단체 버전을 만들고 싶어 이 Organization를 만들었습니다.

Organizaition 규칙과 Repository 작성 컨벤션에 대해서 설명하겠습니다.

가입 신청 주소 : https://choiheejae.typeform.com/to/rQOMHB

🤝 Organization 규칙

  1. 어떤 주제에 상관 없이 오늘 공부한 내용을 commit 할 수 있다.
    • 정치적 성향 또는 광고적 느낌이 있는 주제 등 논란이 될 수 있는 주제는 만들 수 없다. 만약 만들 경우 Organization Admin에 한하여 제재를 가할 수 있다.
  2. 주제는 repository 단위로 묶인다.
  3. 동일한 주제의 repository는 만들 수 없다.
    • 주제가 동일한지에 대한 의견 제의는 누구나 할 수 있다.
  4. 서로의 호칭은 "~님"으로 통일하고 서로 반말은 사용하지 않는다.또한 비속어, 욕설 등을 사용하지 않습니다.
  5. 항상 타인을 존중하는 태도를 가져야 한다.

📝 Repository 컨벤션

  1. 이 컨벤션은 모든 Repository에 적용된다.
  2. 기본 확장자는 .md로 한다.
    • Contribution 협의 하에 확장자 선택은 자유롭다.
  3. Repository 내에 디렉토리 형식은 Contribution 협의 하에 자유롭다.
  4. 중복 된 주제를 가진 파일이 있을 때는 master로 바로 push 하지말고, pull request와 review 기능을 활용 합니다.
  5. 공부한 내용을 기록하는 파일의 시작에는 작성자를 꼭 적어 줍니다.
  6. 공부한 내용을 기록 할 때 참고한 자료가 있을 시 꼭 출처를 남겨 줍니다.

⭐️ TWL 추천 진행 방법

1. 디렉토리 이용하기

참여하는 contributor 마다 folder를 만듭니다.

folder의 이름은 contributor의 깃헙 아이디를 적습니다

각자의 폴더에 공부한 내용을 정리합니다

2. 파일명 이용하기

file 명 컨벤션을 맞춥니다.

  [공부 주제]_[작성자 아이디].md

이런 식으로 구분 합니다.


위 규칙은 수정 커밋의 날짜 기준 3일 뒤부터 적용됩니다.

About

꼭 한 번 씩 읽어주세요

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published