repository 명명 규칙(chatgpt에게 물어봤다)

깃에 프로젝트 만들때 마다 항상 명명 규칙이 항상 헷갈리고 이렇게 만드는게 맞는지 의구심이 들어서 gpt에게 물어봤다.

아래의 다변을 참고 해서 이름을 지으면 좋을거 같다. 결론부터 말하지면 소문자-소문자 이런식으로 너무 길지 않게 의미가 있는

이름으로 작명하면된다고 한다. 그동한 대부분 카멜케이스로 했는데… 고쳐야 겠다 ㅎㅎ

 


Answer

정확한 규칙은 없지만, 보통 프로그램 이름과 Git 저장소 이름을 결정할 때 다음과 같은 관례를 따르는 것이 일반적입니다. 이러한 관례는 코드베이스의 가독성과 일관성을 유지하고 협업을 원활하게 하기 위한 것입니다.

  1. 소문자를 사용하십시오: Git 저장소의 이름은 소문자로 작성하는 것이 좋습니다. 이렇게 하면 대소문자 구분으로 인한 혼란을 피하고, 다른 운영 체제에서도 문제가 없게 됩니다.
  2. 하이픈(-)을 사용하십시오: Git 저장소 이름은 공백 대신 하이픈을 사용하여 단어를 구분하는 것이 좋습니다. 이렇게 하면 이름이 더 읽기 쉬워지고, 일반적인 관례를 따르게 됩니다.
  3. 의미 있는 이름을 사용하십시오: 프로젝트 이름은 해당 프로젝트의 내용을 잘 반영해야 합니다. 다른 사람이 프로젝트를 봤을 때 어떤 프로젝트인지 쉽게 이해할 수 있도록 직관적이고 의미 있는 이름을 선택하십시오.
  4. 사용 언어나 기술을 포함할 수 있습니다: 만약 프로젝트가 특정 언어나 기술과 관련이 있다면, 이름에 해당 정보를 포함시킬 수 있습니다. 예를 들어, “study-project-python”과 같이 사용 언어를 명시할 수 있습니다.
  5. 길지 않게 하십시오: 이름이 너무 길면 기억하기 어렵고 입력하기도 번거로워질 수 있습니다. 간결한 이름을 선택하는 것이 좋습니다.

좋은 예시:

  • study-project
  • my-cool-app
  • web-portfolio

나쁜 예시:

  • StudyProject (대소문자 구분 문제)
  • studyProject (대소문자 구분 문제)
  • study_project (언더스코어 대신 하이픈 권장)
  • my_very_long_and_complicated_project_name (너무 긴 이름)

프로그램 이름과 Git 저장소 이름을 정할 때 이러한 관례를 따른다면, 협업과 코드 관리가 원활해지고 다른 개발자들이 쉽게 참여할 수 있습니다.

Leave A Reply

이메일 주소는 공개되지 않습니다. 필수 필드는 *로 표시됩니다