Bazel 관련 프로젝트 이름 지정

<ph type="x-smartling-placeholder"></ph> 문제 신고 소스 보기 1박 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

먼저 Bazel 생태계에 기여해 주셔서 감사합니다. 다음으로 문의하세요. Bazel 커뮤니티를 bazel-discuss 메일링 리스트를 사용하여 프로젝트와 추천 이름을 공유하세요.

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

Starlark 규칙 이름 지정

새 Starlark 규칙 배포를 참조하세요. 확인할 수 있습니다

이 섹션은 Bazel 생태계를 보강하는 도구를 빌드하는 경우에 적용됩니다. 예를 들어 새 IDE 플러그인이나 새 빌드 시스템 마이그레이션자가 있습니다.

도구에 적합한 이름을 고르는 것은 쉽지 않습니다. 우리도 조심하지 않고 코드명이 많으면 Bazel 생태계를 이해하기가 매우 어려워질 수 있습니다. 있습니다.

Bazel 도구의 이름을 지정하려면 다음 가이드라인을 따르세요.

  1. 새 브랜드 이름 도입 안함: 'Bazel' 이미 신규 브랜드임 너무 많은 새로운 이름으로 혼동하지 않아야 합니다.

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

  3. 도구의 기능을 설명하는 이름을 사용하는 것이 좋습니다. 이상적으로는 이름에 부제목이 없어도 사용자가 첫 번째 제품을 볼 수 있습니다. 도구가 어떤 일을 하는지 추측할 수 있습니다 영어 단어를 공백으로 구분하여 사용하는 것이 좋습니다. 이 목표를 달성할 수 있습니다.

  4. 꽃이나 음식 테마를 반드시 사용해야 하는 것은 아님: Bazel은 basil이라는 식물입니다 당신이 식물, 음식 또는 '바질'과 관련된 이름을 찾습니다.

  5. 도구가 다른 서드 파티 브랜드와 관련된 경우 설명자: 예를 들어 'Bazel migrator for Cmake'를 사용합니다. 를 'Cmake Bazel migrator'

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

좋은 이름의 예:

  • Eclipse용 Bazel: Bazel을 사용하려는 사용자는 이것을 이해할 수 있습니다. Eclipse를 사용하면 여기에서 살펴봐야 합니다. 서드 파티 브랜드를 사용합니다. 설명어로 사용해야 합니다
  • Bazel buildfarm: 'buildfarm' 은 컴파일 팜을 실행합니다. 사용자 수 이 프로젝트가 서버 구축과 관련되어 있음을 이해할 것입니다.

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

  • Ocimum: 바질의 학명 Bazel 프로젝트와 충분히 관련이 없습니다.
  • Bazelizer: 이 이름의 도구는 많은 작업을 할 수 있는데, 이 이름은 설명이 충분하지 않습니다.

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