Code Monkey home page Code Monkey logo

commitconvention's Introduction

작성 규칙


① 제목(type), 본문(body), 꼬리말(footer)로 구성합니다.
② 제목(type)에는 중요도에 따라 gitmoji를 1~3개 사용합니다.
③ 각 부분은 줄바꿈으로 구분합니다.

ex)
Feat 🎨: TodoController create 기능 구현

Body: create(what)는 사용자가 게시글을 작성하기 위해(why) 사용하는 메서드입니다.

create는 (how) FE 서버에서 사용자가 값을 입력하면 이를 감지하고 서버에 저장합니다.(e.target.value)
이후 fetch()메서드를 사용하여 BE 서버로 해당 값을 전달합니다.
BE 서버는 전달 받은 값을 파라미터로 해당 메서드에 전달합니다.
최종적으로 DB에 저장됩니다.

Fixes : #40 Related to: #29, #30


제목(type) 작성하기

type description
Feat 🎨 새로운 기능 추가
Fix 🚑 버그 수정
HOTFIX 🔥 치명적 버그 수정
Comment 🔖 주석 수정
Docs 📝 문서 수정
Design 💄 디자인 변경
Style ✏️ 사소한 코드 변경
BREAKING ⚡ 커다란 API 변경
Refactor ♻️ 리팩토링
Depend ➕ 의존성 추가
Depend ➖ 의존성 삭제
Test ✅ 테스트 작업
Rename 🗃️ 파일, 폴더명 수정
Move 🚚 파일, 폴더 경로 변경
Remove 🗑️ 파일 삭제
Chore 🧑‍💻 기타 사소한 작업
Chore 🎉 새로운 프로젝트 시작
Conf 🔧: 설정 파일 작업
DB 🗃️: DB 관련 작업

ex)
Feat 🎨: TodoController create 기능 구현


본문(body) 작성하기

① 자세히 작성합니다.
② 무엇을(what) 왜(why)를 중심으로 작성합니다.
③ 한 줄당 72자가 넘지 않도록 합니다.

ex)
Body: create는 사용자가 게시글을 작성하기 위해 사용하는 메서드입니다.

create는 FE 서버에서 사용자가 값을 입력하면 이를 감지하고 서버에 저장합니다.(e.target.value)
이후 fetch()메서드를 사용하여 BE 서버로 해당 값을 전달합니다.
BE 서버는 전달 받은 값을 파라미터로 해당 메서드에 전달합니다.
최종적으로 DB에 저장됩니다.


꼬리말(footer) 작성하기

① 꼬리말은 선택사항(optional)입니다.
② 이슈 트래커 ID를 작성합니다.
③ 여러 개의 이슈 번호는 쉼표로 구분합니다.


이슈 트래커 유형

Fixes : 이슈 수정 중
Resolves : 이슈 해결
Ref :thread : 참고할 이슈
Related to : 해당 커밋에 관련된 커밋 번호

ex)
Fixes : #40 Related to: #29, #30


commitconvention's People

Contributors

parkirae avatar mydream757 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.