설명서Commerce구현 플레이북

Adobe Commerce에 대한 일반 개발 모범 사례

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

작성 대상:

  • 경험
  • 개발자

이 항목에서는 정상적인 Adobe Commerce 개발 프로세스의 기준선에 대해 설명합니다. 개발자를 안내하는 기본 프로세스, 코딩 원리, 애플리케이션 설계 원리에 대해 설명한다.

NOTE
Adobe 기술 설계자는 이러한 모범 사례를 개발과 관련된 참여 중 참조로 사용합니다.

이러한 우수 사례는 수년간의 Commerce 프로젝트 개발 및 제공 경험을 기반으로 개발되었습니다. Adobe은 기술 이니셔티브가 이러한 모범 사례를 따르고 기존 프로세스와 코드를 이에 맞게 개선할 것을 권장합니다.

텍스트 규칙

이 항목에서 "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD", "SHOULD NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" 및 "OPTIONAL"이라는 주요 단어는 RFC 2119에 설명된 대로 해석됩니다.

프로세스

  1. 프로젝트 활동을 시작하기 전에 정의된 프로젝트 방법론에 동의해야 합니다. 이는 스크럼, Waterfall, 또는 임의의 다른 방법론 또는 방법론의 조합이 정의될 수 있는 한 될 수 있다.
  2. 개발 팀은 버전 제어 시스템의 분기 전략을 사용할 수 있을 때까지 개발을 시작하지 않아야 합니다.
  3. 기술 사양, 사용자 스토리 및 사용 사례에 대한 승인 및 테스트 사례에 대한 승인 이후에 개발을 시작하지 않아야 하며, 개발 팀이 테스트 사례에 대한 승인을 사용할 수 있습니다.
  4. 적어도 개발 및 QA 환경을 사용할 수 있을 때까지는 개발을 시작하지 않아야 합니다.
  5. 개발을 시작하는 데 필요한 프로젝트 관련 요구 사항은 준비의 정의 ​에 문서화될 수 있습니다.
  6. 승인 작업은 프로젝트 결과물에 대한 승인을 받은 고객 담당자가 수행해야 합니다.
  7. 애자일 프로젝트 방법론에서 승인을 받으면 추가 요구 사항이 따를 수 있습니다. 이러한 요구 사항은 새로운 요구 사항으로 취급되어야 하며 그에 따라 캡처, 설계 및 계획되어야 합니다.
  8. 모든 개발은 제출하기 전에 개발자가 기능적으로 테스트해야 합니다.
  9. 모든 개발은 코드 검토를 위해 제출되기 전에 자동화된 테스트를 통과해야 합니다. 이는 끌어오기 요청 생성 후 자동화된 프로세스로 구성될 수 있습니다.
  10. 모든 개발은 품질 보증을 위해 제출되기 전에 기술 설계자 또는 수석 개발자의 수동 코드 검토를 통과해야 합니다.
  11. 모든 개발은 고객에게 전달하기 전에 품질 보증을 통과해야 합니다.
  12. 게재에 필수인 프로젝트별 요구 사항은 "완료의 정의"에 문서화될 수 있습니다.

환경

  1. 모든 개발자는 동일한 IDE를 사용해야 합니다. PhpStorm은 Adobe Commerce 개발에 권장되는 IDE입니다.
  2. 모든 개발자는 (향후) 프로덕션 서버에서 사용되는 것과 동일한 기술 스택을 사용하여 개발 및 테스트해야 합니다. 이 기술 스택에 있는 소프트웨어 버전은 프로덕션 서버에 설치된 소프트웨어의 주 버전 및 부 버전과 일치해야 합니다. Adobe Commerce의 일반적인 기술 스택에 대한 자세한 내용은 시스템 요구 사항을 참조하십시오.
  3. 시스템 관리자 또는 기술 설계자는 팀에게 중앙 집중식으로 관리되는 로컬 개발 환경을 제공하여 동등하고 최신 로컬 환경을 보장하고 홍보할 수 있습니다.
  4. 개발자와 QA 엔지니어는 QA 환경의 명령줄, 데이터베이스 및 로그 파일에 액세스할 수 있어야 합니다. 이 경우 VPN 연결이 필요할 수 있습니다.

코딩 표준

  1. 모든 코드는 아키텍처, 방법론 및 코딩 표준의 규칙을 따라야 합니다. 창의성은 형식이 아닌 기능에서 요구되는 것이다.
  2. 모든 코드는 Adobe Commerce 아키텍처 안내서와(과) 일치해야 합니다.
  3. 모든 코드는 Adobe Commerce 코딩 표준을 준수해야 합니다.
  4. 모든 코드는 Adobe Commerce 기술 지침을 준수해야 합니다.
  5. 해당되는 경우 모든 코드는 Adobe Commerce 모범 사례를 구현해야 합니다.
  6. 모든 코드는 PHP-Framework Interoperability Group(FIG) 표준을 준수해야 합니다.
  7. 가능하면 Adobe Commerce 기술 비전을 고려하는 것이 좋습니다.
  8. 외부 시스템과의 모든 통합에는 비즈니스 프로세스를 검증하는 통합 테스트가 있어야 합니다.
  9. 모든 모듈은 테스트 범위를 가져야 합니다. 정확히 무엇을 테스트할지 개발 팀이 기술 설계자 또는 수석 개발자와 협력하여 결정해야 합니다. 이 결정은 정량적 조치가 아닌 정성적 조치에 기초해야 합니다. 높은 코드 적용률은 성공의 지표가 아니며 높은 코드 품질을 의미하지도 않습니다. 오히려, 프로그램의 해당 부분에서 회귀의 확률과 심각도를 평가하여 코드의 일부를 다루지 않을 위험을 판단하십시오.

버전 관리

모듈 버전은 시맨틱 버전 관리 2.0.0 표준을 준수해야 합니다.
Adobe Commerce 코드베이스에 대한 종속성은 모듈 버전 종속성 지침을 따라야 합니다.

개정 관리

커밋에는 의미 있는 커밋 메시지가 포함되어야 합니다.

보안

  1. 비보안 함수를 사용하면 안 됩니다.
  2. XSS 방지 전략을 적용해야 합니다.
  3. 콘텐츠 보안 정책을 적용해야 합니다.
  4. 새 Adobe Commerce 인스턴스는 아직 "보안 수정 종료" 날짜에 도달하지 않은 버전의 최신 보안 릴리스에 제공되어야 합니다. Adobe Commerce 소프트웨어 수명 주기 정책을 참조하십시오.
recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60