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

[Docs] 애플퍼프걸s의 행복한 코딩생활을 위한 컨벤션 정리🧹 #38

Open
Guryss opened this issue Aug 3, 2024 · 4 comments
Assignees
Labels
Docs 책빵 관련 문서를 정리합니다.

Comments

@Guryss
Copy link
Collaborator

Guryss commented Aug 3, 2024

Working Convention

  1. Issue를 생성합니다.
  2. Issue 번호와 함께 main 브랜치로부터 새로운 브랜치를 생성합니다. (ex: Feat/#120)
    ㄴ 이때, 내가 가진 main branch는 최신화 해주어야겠죠? 꼭, pull 해옵시다.
  3. 내가 만든 브랜치에서 작업 진행합니다.
  4. 작업이 끝났으면 Commit, Push 해주세요.
    ㄴ 커밋은 최대한 여러 단위로 끊어서 작업 해주는 게 좋습니다! 한번에 하나의 Commit은 지양합시다.
  5. Pull Request를 통해 다른 팀원들에게 본인의 작업물을 보여주세요.
  6. 리뷰를 받은 후에 main 브랜치에 merge 합니다.
    ㄴ Conflict이 생겼다면 혼자 해결해보도록 노력해봐도 좋으나, 구리스를 호출해보세요 🛎️
  7. 원격의 main branch 가 업데이트 되었으니, 다시 내가 가진 main branch 를 최신화 해주어야겠죠?
  8. 위 내용을 반복하면 됩니다.
@Guryss Guryss self-assigned this Aug 3, 2024
@Guryss
Copy link
Collaborator Author

Guryss commented Aug 3, 2024

Issue Convention

[Prefix] 이슈 내용


Ex)
[Design] SearchBook UI 구현
[Fix] Home Core Data 관련 로직 수정

@Guryss
Copy link
Collaborator Author

Guryss commented Aug 3, 2024

Commit Convention

[Prefix] #이슈번호 - 커밋 내용

Ex)
// 1번 이슈에서 새로운 기능(Feat)을 구현한 경우
[Feat] #1 - 기능 구현
// 1번 이슈에서 레이아웃(Design)을 구현한 경우
[Design] #1 - 레이아웃 구현

@Guryss
Copy link
Collaborator Author

Guryss commented Aug 3, 2024

Prefix 📚

prefix를 사용하여 한 눈에 커밋, 이슈의 용도를 알기 쉽게 한다!

[Design]: 뷰 짜기
[Feat]: 새로운 기능 구현
[Network]: 네트워크 연결
[Fix]: 버그, 오류 해결, 코드 수정
[Add]: Feat 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 View 생성
[Del]: 쓸모없는 코드, 주석 삭제
[Refactor]: 전면 수정이 있을 때 사용합니다
[Remove]: 파일 삭제
[Chore]: 그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 파일이름 변경
[Docs]: README나 WIKI 등의 문서 개정
[Setting]: 세팅
[Test]: 테스트 코드
[Merge]: merge

@3405000
Copy link
Collaborator

3405000 commented Aug 3, 2024

구리스눈감아

@Guryss Guryss changed the title [Convention] 애플퍼프걸s의 행복한 코딩생활을 위한 컨벤션 정리🧹 [Docs] 애플퍼프걸s의 행복한 코딩생활을 위한 컨벤션 정리🧹 Aug 3, 2024
@Guryss Guryss added the Docs 책빵 관련 문서를 정리합니다. label Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 책빵 관련 문서를 정리합니다.
Projects
None yet
Development

No branches or pull requests

2 participants