Home

프롬프트

''' GitHub Wiki에 Django mini 프로젝트 컨벤션 가이드를 줄려고 해. 아래와 같이 간단하게 작성해줘.

1. VSC 익스텐션 가이드
2. Python 코딩 스타일 가이드
3. 깃 관리, 깃모지 및 커밋 가이드 '''

답변

'''

Django Mini Project Convention Guide

이 가이드는 Django mini 프로젝트를 진행할 때 팀원들이 지켜야 할 컨벤션에 대해 설명합니다.

1. VSC 익스텐션 가이드

프로젝트를 진행할 때 다음과 같은 VSC 익스텐션을 사용하는 것을 권장합니다.

• Python
• Django
• SQLite
• Git History
• GitLens
• Prettier
• Auto Rename Tag
• Live Server

2. Python 코딩 스타일 가이드

Python 코드를 작성할 때는 PEP 8 스타일 가이드를 따릅니다.

• 들여쓰기는 스페이스 4칸을 사용합니다.
• 최대 줄 길이는 79자입니다.
• 함수와 클래스 사이에는 빈 줄을 두 줄 추가합니다.
• 모듈 임포트는 알파벳 순서로 정렬합니다.
• 변수와 함수 이름은 snake_case를 사용합니다.
• 클래스 이름은 PascalCase를 사용합니다.

3. 깃 관리, 깃모지 및 커밋 가이드

깃 관리 시 다음 규칙을 따릅니다.

• 브랜치 이름은 feature/기능명 형식을 사용합니다.
• 커밋 메시지는 영어로 작성하며, 제목은 50자 이내로 제한합니다.
• 커밋 메시지 제목 끝에 마침표를 사용하지 않습니다.
• 커밋 메시지 본문은 한 줄당 72자 이내로 제한합니다.

깃모지는 다음과 같이 사용합니다.

• ✨ (sparkles): 새로운 기능 추가
• 🐛 (bug): 버그 수정
• 📝 (memo): 문서 수정
• 🎨 (art): 코드 스타일 개선
• ⚡️ (zap): 성능 개선
• 🔧 (wrench): 설정 파일 수정
• 🚚 (truck): 파일 혹은 경로 이동/이름 변경
• 🔥 (fire): 코드 혹은 파일 제거
• ✅ (white_check_mark): 테스트 추가/수정