Together

together란

팀 피크에서 제공할 서비스를 위한 디자인 시스템입니다.
편의성과, 자율성을 고려하여 개발자의 DX를 최대한 향상시키위해 개발중입니다.

코드 컨벤션

네이밍 규칙

variant(변수)

• 이름은 대소문자를 구분하며 소문자와 대문자는 다릅니다.
• 문자로 변수 이름을 시작하고 camelCase이름에 사용합니다. (_와 같은 문자 사용 X)
• 배열 디스트럭처링과 같은 상황에서 특정 인덱스를 사용하지 않지만 불러올 경우가 발생한다면 _문자로 표시하여 사용하지 않는다는 것을 명시합니다.
• 변수 이름은 저장된 값을 설명하는 자체 설명적이어야 합니다. (예 대고소 학생 수 -> number: X, numberOfStudent: O)
• boolean 타입의 변수는 일반적으로 is와 has를 붙여 명시합니다. (isDark, hasToken)

function(함수)

• 변수와 마찬가지로 대소문자를 구분하여 사용합니다.
• 함수 이름을 문자로 시작하고 camelCase이름에 사용합니다.
• 설명이 포함된 이름, 일반적으로 명령형의 동사를 사용합니다. (예: getStudentList)
• 일반적인 접두사는 get, make, apply 등을 사용합니다.

constant(상수)

• 파일, 함수 또는 클래스의 맨 위에 상수를 정의하십시오.
• UPPER_SNAKE_CASE 규칙을 사용합니다.

prettier 규칙

규칙을 맞추지 않더라도 자동으로 설정됩니다.

• semi(true): 세미콜론은 ; 붙이도록 되어있습니다.
• singleQuote(false): ""를 사용하도록 설정됩니다.
• tabWidth: 2
• printWidth: 줄의 길이는 80으로 기본 설정되어있습니다.
• bracketSpacing(true): { name: "name" }과 같이 대괄호 사이에 공백을 유지합니다.

테스트

테스트와 관련된 모든 작업은 storybook을 통해서 확인합니다.

버저닝 규칙

MAJOR: API 호환성이 깨질만한 변경사항
MINOR: 하위 호환성 지키면서 API 기능이 추가된 것
PATCH: 하위 호환성 지키는 범위 내에서 버그가 수정된 것