Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

코드 규칙 #1

Open
nemobim opened this issue Mar 14, 2024 · 1 comment
Open

코드 규칙 #1

nemobim opened this issue Mar 14, 2024 · 1 comment
Assignees
Labels
📃 Docs 문서 작성 및 수정 (README.md 등)

Comments

@nemobim
Copy link
Contributor

nemobim commented Mar 14, 2024

  • 기능 구현 끝나면 커밋하기 (no error)
  • 본인 외 코드 수정 시에는 미리 말하기
  • 커밋은 기능단위 별로 진행하기
  • dev에 풀리퀘스트 할때는 리뷰 1명 필요 (승인해야 올라갑니다)
  • 기능 구현 끝나고 커밋할 때는 사용했던 console.log 지워주세요
  • 변수명은 사용하는 입장에서 생각해서 달아주세요
    boolean : is~
    array : ~s
  • 기능별 주석 달기 (일반 주석: //) ⇢ / export 할 때 사용하는 주석 /*
  • 함수는 동사로 작성 ex)loadingUser
  • 변수는 camelCase로 작성
  • 타입 TUser / 인터페이스 IUser 앞글자에 어떤 타입인지 붙여서 명명
@nemobim nemobim added the 📃 Docs 문서 작성 및 수정 (README.md 등) label Mar 14, 2024
@nemobim
Copy link
Contributor Author

nemobim commented Mar 14, 2024

커밋 유형 의미
Feat 새로운 기능 추가
Fix 버그 수정
Docs 문서 수정
Style 코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
Refactor 코드 리팩토링
Test 테스트 코드, 리팩토링 테스트 코드 추가
Chore 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
Design CSS 등 사용자 UI 디자인 변경
Comment 필요한 주석 추가 및 변경
Rename 파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
Remove 파일을 삭제하는 작업만 수행한 경우
!BREAKING CHANGE 커다란 API 변경의 경우
!HOTFIX 급하게 치명적인 버그를 고쳐야 하는 경우

ex) #1 [Feat] 폴더 구조 생성
#이슈번호하면 이슈랑 같이 커밋이랑 연결할 수 있어요!

sangmee123 added a commit that referenced this issue Mar 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📃 Docs 문서 작성 및 수정 (README.md 등)
Projects
Status: 💡필독!!!
Development

No branches or pull requests

2 participants