반응형 개발 기본 규칙 및 환경설정13 [개발 규칙] Git Commit Message Git Commit Message 규칙Git Commit Message 형식타입: 제목본문꼬리말타입- feat: 새로운 기능 추가- fix: 버그 수정- docs: 문서 수정- style: 코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우- refactor: 코드 리팩토링- test: 테스트 추가 또는 수정- chore: 빌드 업무 수정, 패키지 매니저 설정 등- perf: 성능 향상 관련 변경- ci: CI 설정 파일 및 스크립트 변경- build: 빌드 시스템 또는 외부 종속성에 영향을 미치는 변경 사항제목- 길이: 50자 이내- 스타일: 동사(현재 시제)로 시작하고 첫 글자는 대문자 사용- 마침표: 제목 끝에 마침표 사용하지 않음예시feat: Add user authentication본문- 길.. 2024. 7. 19. [개발 규칙] 협업 규칙 1. 코드 스타일 가이드 설정- 팀 내에서 사용할 코드 스타일 가이드를 선택하거나 정의- Airbnb, Google, Standard 등 유명한 스타일 가이드를 참고- 스타일 가이드 문서를 작성하고 공유2. 코드 리뷰 프로세스코드 리뷰 프로세스를 도입하여 코드 품질을 높이고 일관성을 유지- Pull Request (PR): 모든 변경 사항은 PR을 통해 제출- 리뷰어 지정: 팀원이 번갈아 가며 리뷰를 담당- 리뷰 가이드라인: 리뷰 시 확인해야 할 체크리스트를 작성코드 리뷰 체크리스트 예시- [ ] 코드 스타일 가이드를 준수했는가?- [ ] 함수와 변수의 네이밍이 적절한가?- [ ] 불필요한 콘솔 로그가 없는가?- [ ] 주석이 충분히 작성되었는가?- [ ] 예외 처리가 잘 되어 있는가?- [ ] 테스트 .. 2024. 7. 19. [기본 규칙] Javascript 프로젝트 구조 2024. 7. 19. [개발 규칙] Javascript 코딩컨벤션 공통 규칙1. 들여쓰기: 보통 2칸 스페이스를 사용2. 각 줄은 80자 또는 100자로 제한3. 모듈 레벨 함수 및 클래스 정의는 두줄 간격으로 작성4. 괄호, 중괄호, 대괄호 내부에는 공백 사용 금지5. 쉼표, 콜론, 세미콜론 앞에 공백 사용 금지. 뒤에는 공백 사용6. 주석은 한 줄의 경우 //을 사용하고 코드와 두칸의 공백을 둠. 여러 줄의 경우 /** ~ */을 사용7. docstring 작성시 JSDoc을 사용./** * Adds two numbers together. * @param {number} a - The first number. * @param {number} b - The second number. * @return {number} The sum of the two numbers. .. 2024. 7. 19. [환경설정] Javascript 환경설정 WindowsNode.js 사용법(버전 고정)1. Node.js 다운로드- 버전, LTS과 CPU 확인 후 Windows installer 다운- 다운로드후 설치 2. terminal에서 node.js 버전확인node -vnpm -vNVM 사용법(버전 변경 가능)1. nvm 설치- nvm-setup.zip 압축 해제후 .exe를 실행하여 설치- 설치 후 환경변수(Path)에 추가 2. terminal에서 버전확인# nvm 버전확인nvm version# node.js 20 버전 설치nvm install 20# 설치된 node.js 목록nvm list# 사용할 node.js 버전 설정nvm use # node 버전 확인node -v MacOSNode.js 사용법(버전 고정)1. homebrew로 node.j.. 2024. 7. 19. [기본 규칙] Python 프로젝트 구조 기본 프로젝트 구조project_name/├── project_name/│ ├── __init__.py│ ├── module1.py│ ├── module2.py│ └── ...├── tests/│ ├── __init__.py│ ├── test_module1.py│ ├── test_module2.py│ └── ...├── docs/│ └── ...├── scripts/│ └── ...├── .gitignore├── requirements.txt├── setup.py└── README.md디렉토리 및 파일 설명프로젝트 루트 디렉토리 (project_name/): 프로젝트 전체를 포함하는 최상위 디렉토리입니다.패키지 디렉토리 (project_name/): 실제 코드가 포함된.. 2024. 7. 19. [기본 규칙] Python 코딩컨벤션 공통 규칙1. 들여쓰기는 공백 4칸을 사용. tab 사용 불가2. 각 줄의 최대 길이는 79자로 제한. 길어질 경우 \ 또는 괄호를 사용하여 다음줄로 나눔3. 모듈 레벨 함수 및 클래스 정의는 두줄 간격으로 작성4. 괄호, 중괄호, 대괄호 내부에는 공백 사용 금지5. 쉼표, 콜론, 세미콜론 앞에 공백 사용 금지. 뒤에는 공백 사용6. 주석은 한 줄의 경우 #을 사용하고 코드와 두칸의 공백을 둠. 여러 줄의 경우 """을 사용7. docstring 작성시 """을 사용 변수 및 함수1. 변수 및 함수명은 영어소문자 및 밑줄(_)로 구성된 snake_case로 작성2. 상수는 영어대문자 및 밑줄(_)로 작성. 모듈 수준에서만 작성.3. 연산자 앞뒤에 공백 사용4. 문자열의 경우 쌍따옴표(")를 사용5. 함수.. 2024. 7. 19. [환경설정] Python 환경설정 Windowspython 사용법(버전 고정)1. python 다운로드- 버전, LTS과 CPU 확인 후 Windows installer 다운- 다운로드후 custom install을 하여 모든 유저에게 허용되도록 체크하여 설치 2. powershell에서 버전확인python --versionconda 사용법(버전 변경 가능)1. miniconda 설치- 실행 파일 다운로드하여 설치- 설치 후 환경변수(Path)에 추가 2. 가상환경 생성 및 삭제# 가상환경 생성conda create --name python=# 가상환경 삭제conda env remove --name 3. 가상환경 실행conda activate 4. 버전확인python --version MacOSpython 사용법(버전 고정)1. ter.. 2024. 7. 19. [기본 규칙] C++ 프로젝트 구조 프로젝트 구조 디렉토리 및 파일 설명 2024. 7. 5. 이전 1 2 다음 반응형
