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

표준화된 프로젝트 지침을 만들면 모든 팀원이 일관된 가이드라인 내에서 작업할 수 있습니다. 프로젝트의 기술적 토대를 문서화하는 것부터 시작하여 지침에 포함해야 할 정보를 식별하십시오. 정확한 범위는 팀의 필요에 따라 다르지만 일반적으로 가능한 한 많은 정보를 제공하는 것이 가장 좋습니다. 모든 팀원이 따르는 포괄적인 지침을 만들면 프로젝트 전체에서 코드를 작성, 테스트 및 배포하는 방법에 대한 공유된 이해를 구축하여 유지 관리가 용이하고 일관된 소프트웨어를 만들 수 있습니다.
팀의 사용자 지정 지침에 대해 고려할 몇 가지 주제와 예는 다음과 같습니다.
  1. 테스트 프레임워크 및 특정 명령어
    • “모든 구성 요소에는 최소 85%의 커버리지를 갖는 Jest 테스트가 포함되어야 합니다. 풀 리퀘스트를 제출하기 전에 npm run test:coverage를 사용하여 테스트를 실행하십시오.”
  2. 명시적인 라이브러리 기본 설정
    • “데이터 가져오기 및 상태 관리에 React Query를 사용하십시오. 복잡한 전역 상태에 특별히 필요한 경우가 아니면 Redux를 사용하지 마십시오. 스타일링에는 src/styles/theme.js에 있는 사용자 지정 테마 구성을 사용하여 Tailwind CSS를 사용하십시오.”
  3. 문서 찾는 곳
    • “모든 API 문서는 ‘Engineering > API Reference’ 아래 내부 Notion 작업 공간에서 사용할 수 있습니다. 구성 요소 사용 예는 https://storybook.internal.company.com의 Storybook 인스턴스를 참조하십시오.”
  4. 사용할 MCP 서버 및 용도
    • “데이터베이스 작업에는 ‘Development > Database’ 아래 1Password에 저장된 자격 증명이 있는 Postgres MCP 서버를 사용하십시오. 배포에는 IAM의 배포 역할이 필요한 AWS MCP 서버를 사용하십시오. 구성 지침은 docs/mcp-setup.md를 참조하십시오.”
  5. 프로젝트별 코딩 규칙
    • “모든 React 구성 요소 이름은 PascalCase를 사용하고 모든 헬퍼 함수 이름은 camelCase를 사용하십시오. 구성 요소는 유형별이 아닌 기능별로 구성된 src/components 디렉터리에 배치하십시오. 항상 prop 정의에 TypeScript 인터페이스를 사용하십시오.”