[github] naming-rules

Oksun Noh·2024년 11월 24일
0

github

목록 보기
1/3

github 리포지토리 네이밍 룰

  1. 목적: 프로젝트 참여자의 혼란을 줄이고, 원활한 의사 소통을 하는것에 목적을 둔다
  • 기본꼴: service-role-platform
  1. 소문자를 사용한다.
  2. 대시(-)를 사용한다.
  3. 명확하게 작성한다.
  4. 일관성 있게 작성한다.
  5. 더이상 사용하지 않는 프로젝트의 경우 이름 앞에 legacy 접두어를 붙인다.
  • service: 해당 저장소가 기여하고 있는 서비스 또는 프로젝트 명
PJT full nameshort word
Smart Home Careshc
Auto Search Platformautosp
  • role: 해당 저장소가 서비스 또는 프로젝트에서 하는 역할
Project Roledescription
lib라이브러리
server서버
document문서
  • platform: 해당 저장소가 동작하는 플랫폼 또는 프로그래밍 언어
Platformdescription
javajava 어플리케이션
javascriptjavascript 어플리케이션
windows윈도우에서 동작
profile
저는 만두를 좋아합니다

0개의 댓글