Skip to content
JeongHunMoon edited this page Dec 30, 2023 · 1 revision

Welcome to the SK-C-C-USA-GHOST-OFFICIAL wiki!

JavaScript Convention

Airbnb JS style guide

Git Convention

Branch

feature/01-signin→ {Function}/{Issue num}-{Issue name}

Label

when you make a label, you need to attach label such as feature, documentation, bug, etc for issue, pull request.

Commit

Issue #{이슈번호} {타입}: {제목}
##### 제목은 최대 50 글자까지만 입력 ############## -> |

# 본문은 위에 작성
######## 본문은 한 줄에 최대 72 글자까지만 입력 ########################### -> |

# 꼬릿말은 아래에 작성: ex) #이슈 번호

# --- COMMIT END ---
# <타입> 리스트
#   feat    : 기능 (새로운 기능)
#   fix     : 버그 (버그 수정)
#   refactor: 리팩토링
#   docs    : 문서 (문서 추가, 수정, 삭제)
#   test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore   : 기타 변경사항 (빌드 스크립트 수정 등)
#   layout :
#   res :
# ------------------
#     제목 첫 글자를 대문자로
#     제목은 명령문으로
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------

Issue


  • 이슈 생성하기 막연할텐데, 할 일이나 발생한 문제를 말로 설명해보는 경험을 해봅시다. 소통도 실력임
  • 템플릿 작성
    • 주석을 기준으로 위에 있는건 이슈템플릿의 규칙
    • 주석을 기준으로 아래있는 내용이 이슈를 작성할 때 노출됨
  • 템플릿 소개
    • 기능을 추가하기 전 간단하게 어떻게 할건지 얘기함.
    • 생성된 해당 이슈의 번호를 브랜치 이름으로 사용 ex) feature/#123
    • 버그리포트는 전제된 상황, 발생원인, 결과를 설명.
---
title: ''
about: 기능 추가 전 이슈 템플릿
labels: ''
assignees: ''
---

<!-- 선행
- Assignees 지정
- Labels 지정
- Milestone 지정
-->

## To Do

Issue(Bug)


---
title: ''
about: 버그 리포트용 이슈 템플릿
labels: 'bug'
assignees: ''
---

<!-- 선행
- Milestone 지정
- 자료 확보
-->

## Given <!--버그 발생 전 상황이 어떠한지-->

## When <!--언제 버그가 발생하는지-->

## Then <!--어떤 버그가 발생하는지-->

## 자료 첨부
<!-- <img src="" width=350 /> -->
<!-- 이미지를 본문에 드래그하면 링크가 생성됩니다. -->
  • Label
    • github에서 Issue와 PR이 잘 보이게 하기 위함
    • 알아서 커스텀해서 쓰세요! ㅎㅎ

Pull Request


  • 템플릿 소개
    • PR에 대한 요약
    • 변경사항
    • 참고사진
    • 기타 등등
  • PR 작성자가 정성들여 작성해서 리뷰어의 시간을 아껴주세요.
<!-- 선행
- Assignees 지정
- Labels 지정 (옵션)
- Milestone 지정 (옵션)
-->

## What is the PR?
<!-- 요약
- Resolve: #{이슈넘버} // 해결한 이슈
- Related: #{이슈넘버} // 연관된 이슈
- 참고: [요약](링크)    // 참고한 링크
-->

## Changes
<!-- 변경사항 -->

## Screenshots
<!-- 스크린샷 (Optional)
- 양식: <img src="" width=350 />
-->

## etc
<!-- 비고
- 트러블슈팅 공유, 고민 등을 서술
-->
Clone this wiki locally