이 기사에서는 확실한 참고 가치가 있는 PHP 확장 개발 체크리스트를 소개합니다. 이제 모든 사람과 공유합니다. 도움이 필요한 친구들이 참고할 수 있습니다
성공적인 PHP 확장 패키지를 만들고 싶다면, 단지 코드를 폴더에 넣는 것뿐만 아니라 확장 기능이 좋은지 여부를 결정하는 데 필요한 많은 요소가 있습니다. 다음 체크리스트는 확장 기능을 개선하고 PHP 커뮤니티에서 더 많은 관심을 받는 데 도움이 됩니다.
귀하의 이름이 다른 프로젝트에서 사용되지 않는지 확인하세요.
확장 이름은 PHP 네임스페이스와 일치해야 합니다.
네임스페이스에 자신의 이름이나 개인적인 이름을 사용하지 마세요.
GitHub는 이러한 유형의 공개 프로젝트를 무료로 관리할 수 있습니다.
GitHub는 이 오픈 소스 프로젝트를 관리하고 다른 사람들이 귀하의 확장 기능을 쉽게 얻을 수 있도록 하는 데 매우 유용합니다.
사용하고 싶지 않다면 Bitbucket을 사용해 보세요.
PSR-4 호환 자동 로더 네임스페이스를 사용하세요.
코드를 src
폴더에 넣어주세요.
PHP용 종속성 관리 도구인 Composer를 통해 클래스 라이브러리를 찾을 수 있는지 확인하세요.
주요 Composer 패키지 저장소인 Packagist에 게시됩니다.
하나의 프레임워크에서만 사용할 수 있는 프로젝트에 국한되지 마세요.
서비스 제공자를 통해 프레임워크에 대한 특별 지원을 제공합니다.
PSR-2 코딩 스타일을 따르는 것이 좋습니다.
PHP Coding Standards Fixer와 같은 자동 코드 서식 지정 도구를 사용하세요.
PHP 코드 스니퍼와 같은 코드 스타일 감지 도구를 사용하세요.
대부분의 코드를 다루세요.
일반적으로 사용되는 PHP 단위 테스트 프레임워크인 PHPUnit을 사용하세요.
기타 옵션: phpspec, Behat,atoum, Codeception.
주석을 내장 문서로 처리하세요.
코드 주석은 PhpStorm과 같은 IDE의 코드 자동 완성 기능을 향상시킬 수도 있습니다.
은 자동으로 API 문서로 변환될 수 있습니다. phpDocumentor를 참조하세요.
시맨틱 버전 번호를 사용하여 버전 번호를 관리하세요.
메이저 버전.마이너 버전.패치 버전 사양을 따릅니다.
개발자가 파괴적인 변경에 대한 걱정 없이 소프트웨어를 안전하게 업그레이드할 수 있습니다.
제때 출시 버전을 태그하는 것을 잊지 마세요!
버전 간 중요한 변경 사항을 명확하게 표시하고 표시합니다.
Keep a CHANGELOG 형식을 따르는 것을 고려하세요.
서비스를 사용하여 코딩이 표준인지, 실행 중인 테스트를 통과할 수 있는지 자동으로 확인하세요.
다양한 PHP 버전에서 테스트를 실행하는 것이 좋습니다.
제출하거나 당길 때 자동으로 실행될 수 있는지 확인하세요.
참조: Travis-CI, Scrutinizer, Circle-CI.
확장 패키지에는 훌륭한 문서가 중요합니다.
적어도 라이브러리에 자세한 README(readme) 파일이 있는지 확인하세요.
GitHub 페이지에서 문서 호스팅을 시도해 볼 수 있습니다.
사용 가능한 참조: 문서를 읽어보세요.
작업 결과를 효과적으로 보호할 수 있고 수행하기 쉬운 라이선스 계약이 포함되어 있습니다.
Choosealicense.com을 참조하세요. 대부분의 PHP 오픈 소스 프로젝트는 MIT 라이선스를 사용합니다.
적어도 코드 베이스에 LICENSE 파일을 포함하세요.
또한 Docblocks에 라이센스 계약을 추가하는 것도 고려해 보세요.
모든 사람이 프로젝트 개선에 도움을 주고 싶다면 기여를 요청해야 합니다!
기고자 목록이 나열된 CONTRIBUTING 파일이 있습니다.
이 문서를 사용하여 테스트 환경과 같은 프로젝트 환경 요구 사항을 설명하세요.
더 최신 PHP 지식을 보려면 Laravel/PHP 지식 커뮤니티
로 이동하세요. 관련 권장 사항:
위 내용은 PHP 확장 개발 체크리스트의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!