Skip to content

Commit aed3b06

Browse files
daehwan2yodaehwan2yo
committed
Initial commit
0 parents  commit aed3b06

File tree

10 files changed

+228
-0
lines changed

10 files changed

+228
-0
lines changed

‎.github/.gitmessage.txt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# author > daehwan2yo
2+
# contact > [email protected]
3+
4+
[커밋종류]-[이슈번호]-[간단설명]
5+
6+
## 개요
7+
- 내용을 적어주세요.
8+
9+
## 작업사항
10+
- 내용을 적어주세요.
11+
12+
## 변경로직
13+
- 내용을 적어주세요.
14+
15+
#### 테스트인 경우 이하 내용 작성 ####
16+
# 테스트 내용 (한 줄 72자 내)
17+
18+
*어떤것을 테스트했고, 테스트 성공 여부 작성*
19+
20+
#### (이상) ####
21+
22+
# CREATE _ yellow
23+
🌞[INIT] : 초기 생성
24+
🔥[FEAT] : 새 기능 구현
25+
📁[LIB] : 라이브러리 추가
26+
27+
# MODIFY _ white
28+
📈[UPDATE] : 코드 수정 및 향상 (오류 수정과 다르다)
29+
🔧[FIX] : 버그 및 오류 수정, 해결
30+
💨[MOVE] : 프로젝트 내 파일 주소 변경 시
31+
(* 모든 팀원과 상의 후 높은 브랜치에서 진행)
32+
🖍[RENAME] : 프로젝트 내 파일 명 변경 시
33+
(* 모든 팀원과 상의 후 높은 브랜치에서 진행)
34+
🌪️[REF]: 코드 리팩토링
35+
(코드 전면 수정 시, 모든 팀원과 상의 후 브랜치 충돌에 주의해서 진행)
36+
37+
# REMOVE _ black
38+
🌚[CLEAR] : 코드 삭제
39+
🚥[TIDY] : 중복되는 코드, 기능과 관련없는 코드 등 정리
40+
💣[REMOVE] : 파일 삭제 (* 모든 팀원과 상의 후 높은 브랜치에서 진행)
41+
42+
# TEST
43+
📖[TEST] : 테스트 코드 생성
44+
45+
# GIT
46+
🔀[MERGE] : 기타 브랜치 머지
47+
48+
# ELSE
49+
⚠️[EMG] : 긴급한 작업 수행
50+
📜[DOCS] : 문서 작업
51+
(README, RESTDOCS 등, 프로젝트 스코프에 맞는 브랜치에서 진행)

‎.github/ISSUE_TEMPLATE/DOCS.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: " 문서화 \U0001F4C4"
3+
about: 문서화 작업을 위한 이슈입니다.
4+
title: "[DOCS]"
5+
labels: 문서
6+
assignees: ''
7+
8+
---
9+
10+
## 🥰 문서화할 부분
11+
<!-- 문서화할 부분에대해 설명해주세요. -->
12+
13+
## 😏 목표 완성 기간
14+
<!-- 목표하는 기간을 적어주세요. ex) 3일 (~21/10/30)-->
15+
16+
## 😤 To-do
17+
<!-- 해야 할 일들을 적어주세요. -->
18+
- [ ] todo

‎.github/ISSUE_TEMPLATE/EMERGENCY_BUG.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: "\U0001F469‍\U0001F692 긴급 버그"
3+
about: 긴급하게 수정해야할 버그입니다.
4+
title: "[HOTFIX]"
5+
labels: 긴급, 도움, 버그
6+
assignees: ''
7+
8+
---
9+
10+
```
11+
긴급한 버그이므로 간단한 이슈 작성을 해주세요.
12+
1시간 ~ 이틀 내로 이슈를 닫아주세요.
13+
```
14+
15+
## 🤬 문제 원인
16+
17+
## 👺 수정할 부분

‎.github/ISSUE_TEMPLATE/FEAT.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: "\U0001F31F 기능"
3+
about: 기능을 구현하는 이슈입니다.
4+
title: "[FEAT]"
5+
labels: 기능
6+
assignees: ''
7+
8+
---
9+
10+
## 🤗 구현하는 기능
11+
<!-- 구현할 기능을 작성해주세요. (상세히) -->
12+
13+
## 😳 목표 기간
14+
<!-- 목표하는 기간을 작성해주세요-->
15+
16+
## 😤 To-do
17+
<!-- 해야 할 일들을 적어주세요. -->
18+
- [ ] todo
19+
20+
## 😋 참고사항
21+
<!-- 관련 브랜치, 예상되는 추가기능 등 선택사항 -->

‎.github/ISSUE_TEMPLATE/HELP.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: " \U0001F3C3‍♂ 도움"
3+
about: 다른 팀원의 도움이 필요한 이슈입니다.
4+
title: "[HELP]"
5+
labels: 도움
6+
assignees: ''
7+
8+
---
9+
10+
## 🤗 도움이 필요한 부분
11+
<!--도움이 필요한 부분에 대해 작성해주세요-->
12+
13+
14+
## 😤 To-do
15+
<!-- 해야 할 일들을 적어주세요. -->
16+
- [ ] todo

‎.github/ISSUE_TEMPLATE/SIMPLE_BUG.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "\U0001F477간단한 버그"
3+
about: 간단한 버그를 수정합니다.
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## 😰 안되는 부분 및 예상되는 원인
11+
<!-- 문제가 발생되는 지점과 예상되는 원인을 작성해주세요. -->
12+
13+
## 😑 수정을 해야하는 부분
14+
<!-- 수정해야할 부분을 작성해주세요-->
15+
16+
## 😢 목표 기간
17+
<!-- 목표하는 기간을 작성해주세요-->
18+
19+
20+
## 😤 To-do
21+
<!-- 해야 할 일들을 적어주세요. -->
22+
- [ ] todo

‎.github/ISSUE_TEMPLATE/TEST.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: "테스트 \U0001F469‍\U0001F52C "
3+
about: 테스트를 진행하는 이슈입니다.
4+
title: "[TEST]"
5+
labels: 테스트
6+
assignees: ''
7+
8+
---
9+
10+
## 🤗 테스트하는 기능
11+
<!--테스트하는 기능에 대해 작성해주세요-->
12+
13+
## 😳 목표 기간
14+
<!-- 목표하는 기간을 작성해주세요-->
15+
16+
## 😤 To-do
17+
<!-- 해야 할 일들을 적어주세요. -->
18+
- [ ] todo
19+
20+
## 😋 참고사항
21+
<!-- 관련 브랜치, 예상되는 추가기능 등 선택사항 -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## ISSUES
2+
<!-- 관련된 이슈번호 작성 -->
3+
4+
5+
## PR 목적
6+
7+
8+
## 참고 사항

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 gyedaehwan_daehwan2yo
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# templates
2+
For Project Templates
3+
4+
# Git Message의 중요성
5+
잘쓰인 commit message는
6+
1. 더 좋은 커밋 로그 가독성
7+
2. 더 나은 협업 프로세스
8+
3. 더 쉬운 코드 유지보수
9+
10+
## Commit Message의 7가지 약속 (NHN)
11+
1. 제목과 본문을 한 줄 띄워 분리하기
12+
2. 제목은 영문 기준 50자 이내로
13+
3. 제목 첫글자를 대문자로
14+
4. 제목 끝에 . 금지
15+
5. 제목은 명령조로
16+
6. 본문은 영문 기준 72자마다 줄 바꾸기
17+
7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기
18+
19+
```
20+
소스코드를 보지 않고도 변경 사항이 무엇을 하는지 알 수 있도록 해야한다.
21+
커밋 메시지 본문으로 "왜", "무엇을 위해", "어떻게" 변경했는지와 상세 내용 추가 설명하기
22+
맥락없는 총칭적 메시지 사용 자제하기!
23+
ex. 이거 고침, 잘될거임, CSS조정, 이거 수정함 등
24+
25+
26+
```
27+
## reference
28+
29+
[NHN Cloud - 좋은 커밋 메시지를 작성하기 위한 7가지 약속]
30+
https://meetup.toast.com/posts/106
31+
32+
[커밋 메시지 가이드]
33+
https://github.com/RomuloOliveira/commit-messages-guide/blob/master/README_ko-KR.md

0 commit comments

Comments
 (0)