먼저 Bazel 생태계에 기여해 주셔서 감사합니다. bazel-discuss 메일링 리스트에서 Bazel 커뮤니티에 문의하여 프로젝트와 추천 이름을 공유하세요.
Bazel 관련 도구를 빌드하거나 Skylark 규칙을 공유하는 경우 프로젝트 이름에 다음 가이드라인을 따르는 것이 좋습니다.
Starlark 규칙 이름 지정
문서의 새 Starlark 규칙 배포를 참고하세요.
다른 Bazel 관련 도구 이름 지정
이 섹션은 Bazel 생태계를 보강하는 도구를 빌드하는 경우에 적용됩니다. 예를 들어 새 IDE 플러그인이나 새 빌드 시스템 이전 도구가 여기에 해당합니다.
도구에 적합한 이름을 선택하는 것은 쉽지 않습니다. 주의하지 않고 코드네임을 너무 많이 사용하면 신규 사용자가 Bazel 생태계를 이해하기가 매우 어려워질 수 있습니다.
Bazel 도구의 이름을 지정할 때는 다음 가이드라인을 따르세요.
새로운 브랜드 이름을 도입하지 않는 것이 좋습니다. 'Bazel'은 이미 사용자에게 새로운 브랜드이므로 너무 많은 새 이름으로 혼란을 야기해서는 안 됩니다.
'Bazel'이 포함된 이름을 사용하는 것이 좋습니다. 이렇게 하면 Bazel 관련 도구임을 표현하는 데 도움이 되며 사용자가 검색엔진으로 도구를 찾는 데도 도움이 됩니다.
도구의 기능을 설명하는 이름을 사용하는 것이 좋습니다. 사용자가 도구의 기능을 처음에 파악할 수 있도록 부제목이 필요하지 않은 이름이 이상적입니다. 공백으로 구분된 영어 단어를 사용하는 것이 좋습니다.
꽃이나 음식 테마를 사용할 필요는 없습니다. Bazel은 식물인 바질을 연상시킵니다. 식물, 음식 또는 '바질'과 관련된 이름을 찾을 필요는 없습니다.
도구가 다른 서드 파티 브랜드와 관련이 있는 경우 설명자로만 사용합니다. 예를 들어 'Cmake Bazel migrator' 대신 'Cmake용 Bazel migrator'를 사용하세요.
이 가이드라인은 GitHub 저장소 URL에도 적용됩니다. 저장소 URL을 읽으면 사용자가 도구의 기능을 이해하는 데 도움이 됩니다. 물론 저장소 이름은 더 짧을 수 있으며 공백과 소문자 대신 대시를 사용해야 합니다.
좋은 이름의 예:
- Eclipse용 Bazel: 사용자가 Eclipse에서 Bazel을 사용하려면 이 위치를 확인해야 한다는 점을 알 수 있습니다. 서드 파티 브랜드를 설명자로 사용합니다.
- Bazel buildfarm: 'buildfarm'은 컴파일 농장입니다. 사용자는 이 프로젝트가 서버에서 빌드하는 것과 관련이 있음을 알게 됩니다.
피해야 할 이름의 예는 다음과 같습니다.
- Ocimum: 바질의 학명이 Bazel 프로젝트와 충분히 관련이 없습니다.
- Bazelizer: 이 이름 뒤에 있는 도구는 여러 가지 작업을 할 수 있지만 이 이름은 충분히 설명적이지 않습니다.
이 권장사항은 Google에서 프로젝트를 오픈소스로 공개할 때 사용하는 가이드라인에 따라 작성되었습니다.