vcpkg PR 검토 검사 목록

수정 버전: 1

개요

이 문서에서는 들어오는 끌어오기 요청에 "검토된" 레이블을 적용하는 데 사용하는 주석이 추가된 검사 목록을 제공합니다. 끌어오기 요청이 이러한 점을 위반하는 경우 변경 집합을 병합하기 전에 필요한 변경을 기여자 요청할 수 있습니다.

이 검사 목록을 개선할 수 있다고 생각되면 자유롭게 문제를 만들거나 요청을 끌어올 수 있습니다. 검사 목록 콘텐츠를 수정할 때 수정 번호를 증분하세요.

검사 목록

각 항목 코드에 연결된 링크 주소를 복사하여 GitHub 주석에서 이러한 검사 목록 항목을 연결할 수 있습니다.

c000001: 사용되지 않는 도우미 함수는 사용되지 않습니다.

자세한 내용은 유지 관리자 지침 및 정책을 참조하세요.

c000002: '"port-version"' 필드가 업데이트됨

자세한 내용은 유지 관리자 지침 및 정책을 참조하세요.

c000003: 새 포트에 영어로 작성된 '"description"' 필드가 포함되어 있습니다.

설명은 하나 또는 몇 개의 문장만 긴 것이 도움이 됩니다. 가능한 경우 라이브러리의 공식 설명을 README.md 사용하거나 이와 유사한 설명을 사용하는 것이 좋습니다. 자동 번역은 허용되며 기여자 영어 번역을 클린 수 있게 되어 기쁩니다.

자세한 내용은 매니페스트 파일 설명서를 참조하세요.

c000004: 변경 집합에 불필요한 주석이 없습니다.

자세한 내용은 유지 관리자 지침 및 정책을 참조하세요.

c000005: 다운로드한 보관 파일은 사용 가능한

경우 버전이 지정됩니다. 보관 콘텐츠가 변경되지 않도록 하기 위해 다운로드한 아카이브에는 포트 "version"와 함께 증가될 수 있는 연결된 버전 태그가 있는 것이 좋습니다.

c000006: 새 포트는 라이브러리에서 공식적으로 지원하는 세 배에 대한 CI 검사 전달합니다.

vcpkg 포트의 품질이 높은지 확인하기 위해 들어오는 포트가 해당 라이브러리에 대한 공식 플랫폼을 지원하도록 요청합니다.

c000007: 패치는 vcpkg 관련 문제만 해결합니다.

가능하면 라이브러리 소스 코드에 대한 패치를 라이브러리의 공식 리포지토리에 업스트림 합니다. 라이브러리의 리포지토리에서 끌어오기 요청을 열면 vcpkg 사용자뿐만 아니라 모든 사용자에 대한 라이브러리를 개선하는 데 도움이 됩니다.

c000008: 사용 가능한 경우 새 포트가 공식 소스에서 소스 코드를 다운로드합니다.

라이브러리 작성자를 존중하고 코드를 안전하게 유지하려면 포트가 공식 소스에서 소스 코드를 다운로드하도록 하세요. 원래 소스 코드를 사용할 수 없고 해당 라이브러리를 기본 데 상당한 커뮤니티 관심이 있는 경우 예외를 만들 수 있습니다.

c000009: 포트 및 포트 기능의 이름이 올바르게 지정됩니다.

사용자 접근성의 경우 포트 및 포트 기능의 이름을 직관적이고 공식 원본 및 기타 패키지 관리자의 해당 이름과 가깝게 사용하는 것이 좋습니다. 포트 또는 포트 기능의 이름 지정을 잘 모르는 경우 검색 엔진을 사용하여 repology.org, packages.ubuntu.com 또는 추가 정보를 검색하는 검사 것이 좋습니다. 또한 기여자 도움을 줄 수 있으므로 확실하지 않은 경우 자유롭게 명명 제안을 요청하세요.

c000010: 라이브러리 대상은 적절한 경우 내보내집니다.

사용자에게 원활한 빌드 시스템 통합을 제공하려면 다운스트림으로 사용할 라이브러리 대상을 찾아 내보내고 제공하는 방법을 제공해야 합니다. 내보낼 대상이 아닌 대상은 비공개로 표시되어야 하며 내보내지 않아야 합니다.

c000011: 포트는 사용자의 시스템을 수정하는 애플리케이션을 사용하지 않습니다.

포트는 이렇게 하는 애플리케이션을 방지하여 사용자의 시스템을 수정하지 않는 vcpkg의 계약을 유지해야 합니다. 이러한 애플리케이션의 예는 sudo, apt, brew또는 pip. 가능한 경우 이러한 유형의 프로그램에 대한 대안을 사용하세요.

c000012: 시스템 종속성이 있는 포트에는 설치 중에 정보 메시지가 포함됩니다.

일부 포트에는 vcpkg 내에 존재하지 않는 라이브러리 및 도구 종속성이 있습니다. 이러한 누락된 종속성의 경우 기여자 누락된 종속성과 해당 종속성을 획득하는 방법을 나타내는 메시지를 포트 portfile.cmake 맨 위에 추가하도록 요청합니다. 사용자가 종속성이 누락된 경우 가능한 한 빨리 설치 프로세스를 "초기화"할 수 있도록 주요 작업이 완료되기 전에 메시지가 표시되도록 요청합니다.

예시:

message(
"${PORT} currently requires the following libraries from the system package manager:
    autoconf libtool
These can be installed on Ubuntu systems via sudo apt install autoconf libtool"
)

c000013: 매니페스트 파일은 새 포트에 대한 CONTROL 파일 대신 사용됩니다.

대부분의 기존 포트는 CONTROL 파일 구문을 사용합니다. 이 구문은 당분간 지원되지만 새 포트는 이러한 구문을 사용하지 않아야 합니다. 새로 추가된 모든 포트 는 매니페스트 파일을 사용해야 합니다 .

또한 포트를 크게 수정할 때 매니페스트 파일로 전환하는 것이 좋습니다. 그러나 이 작업은 필요하지 않습니다. 유용할 vcpkg format-manifest 수 있습니다.