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