Skip to content

Latest commit

 

History

History
15 lines (13 loc) · 912 Bytes

CONTRIBUTING.md

File metadata and controls

15 lines (13 loc) · 912 Bytes

CONTRIBUTING

브랜치

  • 내용에 대한 수정 PR은 master 브랜치를 대상으로 올려주세요.
  • 템플릿(스타일링)에 대한 수정은 release 브랜치를 대상으로 PR 올려주셔도 괜찮지만, 가급적 Issue의 형태로 제안해주시면 좋겠습니다.

파일명 작성 규칙(master branch 기준)

  • 소문자만 사용
  • 띄어쓰기는 언더스코어를 이용하여 표시
  • 두 개 이상의 개념을 함께 다룰 때, 비교/대조 중심이면 _vs_로 연결
    • 예시: uri_vs_url
  • 두 개 이상의 개념을 함께 다룰 때, 서로 이웃한 개념이라면 &로 연결
    • 예시: process&thread
  • shorten name이 full name보다 보편적으로 많이 쓰이는 경우에 한해 줄여서 쓰고, 그 외에는 full name을 사용
  • 개념을 다루는 게 아니라 사용법을 다루는 경우 how_to_use_를 붙여서 네이밍 구분