Skip to main content

사용자 지정 지침

팀을 위한 사용자 지정 지침 구축​

표준화된 프로젝트 지침을 생성하면 모든 팀 구성원이 일관된 가이드라인 내에서 작업할 수 있습니다. 먼저 프로젝트의 기술적 기반을 문서화한 다음, 지침에 포함해야 할 정보를 식별하십시오. 정확한 범위는 팀의 필요에 따라 달라지겠지만, 일반적으로 가능한 한 많은 정보를 제공하는 것이 가장 좋습니다. 모든 팀 구성원이 따르는 포괄적인 지침을 생성함으로써, 프로젝트 전반에 걸쳐 코드가 작성, 테스트 및 배포되는 방식에 대한 공유된 이해를 확립하여 더 유지보수 가능하고 일관된 소프트웨어를 만들 수 있습니다.

다음은 팀의 사용자 지정 지침에 고려할 몇 가지 주제와 예시입니다.

  1. 테스트 프레임워크 및 특정 명령
    • "모든 구성 요소는 최소 85%의 커버리지를 가진 Jest 테스트를 포함해야 합니다. 풀 리퀘스트를 제출하기 전에 npm run test:coverage를 사용하여 테스트를 실행하십시오."
  2. 명시적인 라이브러리 선호도
    • "데이터 가져오기 및 상태 관리를 위해 React Query를 사용하십시오. 복잡한 전역 상태에 특별히 필요한 경우가 아니면 Redux를 피하십시오. 스타일링을 위해 src/styles/theme.js에서 찾을 수 있는 사용자 지정 테마 구성과 함께 Tailwind CSS를 사용하십시오."
  3. 문서 위치
    • "모든 API 문서는 내부 Notion 작업 공간의 'Engineering > API Reference'에서 확인할 수 있습니다. 구성 요소 사용 예시는 https://storybook.internal.company.com의 Storybook 인스턴스를 참조하십시오."
  4. 사용할 MCP 서버 및 목적
    • "데이터베이스 작업의 경우, 'Development > Database'에 저장된 자격 증명과 함께 Postgres MCP 서버를 사용하십시오. 배포의 경우, IAM에서 배포 역할을 요구하는 AWS MCP 서버를 사용하십시오. 구성 지침은 docs/mcp-setup.md를 참조하십시오."
  5. 프로젝트별 코딩 규칙
    • "모든 React 구성 요소는 PascalCase를 사용하고 모든 헬퍼 함수는 camelCase를 사용하여 이름을 지정하십시오. 구성 요소는 유형별이 아닌 기능별로 구성하여 src/components 디렉토리에 배치하십시오. 항상 prop 정의에 TypeScript 인터페이스를 사용하십시오."