Bazel 관련 프로젝트 이름 지정

문제 신고 소스 보기

먼저 Bazel 생태계에 참여해 주셔서 감사합니다. bazel-discuss 메일링 리스트에 있는 Bazel 커뮤니티에 문의하여 프로젝트와 그 권장 이름을 공유하세요.

Bazel 관련 도구를 빌드하거나 Skylark 규칙을 공유하는 경우 프로젝트 이름에 대한 다음 가이드라인을 따르는 것이 좋습니다.

Starlark 규칙 이름 지정

문서의 새 Starlark 규칙 배포를 참조하세요.

이 섹션은 Bazel 생태계를 강화하는 도구를 빌드하는 경우에 적용됩니다. 예: 새로운 IDE 플러그인 또는 새 빌드 시스템 이전 도구

적절한 도구 이름을 고르기가 어려울 수 있습니다. Google에서 주의하지 않고 코드명을 너무 많이 사용하면 초보자가 Bazel 생태계를 이해하기가 매우 어려울 수 있습니다.

Bazel 도구 이름 지정에 대한 다음 가이드라인을 따르세요.

  1. 새 브랜드 이름을 도입하지 않는 것이 좋습니다. 'Bazel'은 이미 사용자를 위한 새로운 브랜드이므로 사용자를 너무 많은 새 이름과 혼동해서는 안 됩니다.

  2. 'Bazel'을 포함하는 이름을 사용하는 것이 좋습니다. 이렇게 하면 Bazel 관련 도구임을 표현하고 검색 엔진으로 쉽게 찾을 수 있습니다.

  3. 도구의 역할을 설명하는 이름을 사용하는 것이 좋습니다. 도구의 용도를 가장 잘 추측할 수 있는 이름을 사용하는 것이 좋습니다. 이를 위해 공백으로 구분된 영어 단어를 사용하는 것이 좋습니다.

  4. 꽃 또는 음식 테마를 사용할 필요는 없습니다. Bazel은 식물인 basil을 불러옵니다. 식물, 음식 또는 '바질'과 관련된 이름을 찾지 않아도 됩니다.

  5. 도구가 다른 타사 브랜드와 관련이 있는 경우 설명어로만 사용하세요. 예를 들어 'Cmake Bazel 이전 도구' 대신 'Cmake용 Bazel 이전 도구'를 사용합니다.

이 가이드라인은 GitHub 저장소 URL에도 적용됩니다. 저장소 URL을 읽으면 도구를 이해하는 데 도움이 됩니다. 물론 저장소 이름은 더 짧을 수 있으며 공백과 소문자 대신 대시를 사용해야 합니다.

좋은 이름의 예:

  • Eclipse용 Bazel: Bazel과 Eclipse를 함께 사용하려는 경우 여기에서 살펴봐야 합니다. 서드 파티 브랜드를 설명어로 사용합니다.
  • Bazel buildfarm: 'buildfarm'은 컴파일 팜입니다. 사용자는 이 프로젝트가 서버에 빌드하는 것과 관련이 있다는 사실을 알게 됩니다.

피해야 할 이름의 예는 다음과 같습니다.

  • Ocimum: 바실리언의 과학적 이름은 Bazel 프로젝트와의 관련성이 낮습니다.
  • Bazelizer: 이 이름 뒤에 있는 도구는 많은 작업을 수행할 수 있습니다. 이 이름은 설명이 부족한 이름입니다.

이 권장사항은 Google에서 프로젝트를 오픈소스로 제공할 때 사용하는 가이드라인에 부합합니다.