[github] 템플릿 등록하기

0. 개요

- 개발할 때, 나만 그런지 모르겠는데

대략적 구조 -> 각 기능 분배 및 이슈 설정 -> 개발 -> pr

이런 순서로 진행하고 있다.

 

이 때, 따로 이슈나 pr에 대한 템플릿이 없다면 각 사람마다 다른 구조의 글이 나올 것이다.

때문에 git에서는 이것을 공통화할수 있게끔 설정하였는데, 이에 대해 잠시 알아보자..

---

1. github 연결

- 이전에 로컬 개발 환경을 만들어놓고 remote에 연결하는 방식에 대해 설명한 적이 있다.

[git] git 시작하기

나도 들어가서 따로 보기 귀잖으니 아래에 설명을 다시 적자면

1. github의 작업 레포 생성
2. git bash를 통해 작업 디렉토리 이동/생성(cd / mkdir)
3. 작업 디렉토리 내 git init
4. git branch -M main (기본 브랜치명 master -> main)
5. git remote add origin git@github.com:<user name>/<target repository name>.git (local에 remote 추가)
6. git add . -> git commit -m "Initial commit"
7. 첫 커밋 파일 생성 및 커밋 내역 생성 후 git push -u origin main

순서대로 진행된다.

 

여기까지 진행하면 github의 해당 레포지토리에 파일이 예쁘게 올라온 것을 볼 수 있다 ㅎㅎ

부끄러우니 머리만 보여주겠다.

---

2. .github 디렉토리 내 md 등록

2.1 .github 디렉토리 및 이슈 디렉토리 생성 

처음에 git init 을 통해 연결했으니 .github도 있지 않을까? 라는 생각을 했지만

git bash $ ls -al

찾아봐도 없으니 생성해주도록 하자..

mkdir -p .github/ISSUE_TEMPLATE

 ISSUE_TEMPLATE 디렉토리 안에 이슈 템플릿을 넣을꺼라 -p옵션으로 github 디렉토리와 같이 생성해주었다.

 

1. 프로젝트 하위에 .github 디렉토리 생성

mkdir .github

 

2. 해당 .gitbub 디렉토리 하위에 ISSUE_TEMPLATE 디렉토리 생성

mkdir .github/ISSUE_TEMPLATE

---

2.2 ISSUE_TEMPLATE 내 관련 이슈들에 대한 md 파일 생성

Ex) feature-template.md

---
name: Feature Request
about: '새로운 기능에 대해 제안해 주세요.'
title: ''
labels: enhancement
assignees: ''

---

## 기능 요청
어떤 기능을 요청하고 싶으신가요?

## 사용 이유
이 기능이 왜 필요한지 설명해 주세요.

## 추가 정보
추가로 제공할 정보가 있으면 적어 주세요.

 

이외에도 fix, chore 등등 관련 이슈에 대해 각 템플릿을 제작하면 된다.

---

2.3 config 파일 만들기

- 이슈 생성시, 해당 템플릿이 자동으로 나오게 하기 위해서는 ISSUE_TEMPLATE 디렉토리 안에 config.yml 파일을 등록해야 한다.

- Ex) config.yml

blank_issues_enabled: false
contact_links:
  - name: "이슈 분류"
    url: "/issues/new?template=등록된 템플릿 파일 명"
    about: "나타나는 설명"
  - name: "Feature"
    url: "/issues/new?template=feature-template.md"
    about: "새로운 기능 추가와 관련된 이슈를 기록하는 템플릿입니다."

 

github의 이슈 등록 클릭시 템플릿이 나온다

---

2.4 PR에 대한 템플릿 설정

-  github 디렉토리 하위에 PULL_REQUEST_TEMPLATE.md 를 생성하여 이에 템플릿을 등록한다.

- Ex) PULL_REQUEST_TEMPLATE.md 

## 연관 이슈

- #이슈번호

## 작업 내용

작업한 내용을 간략히 설명해주세요.

## 구현 결과

구현한 기능의 스크린샷을 업로드해주세요.

## 기타 사항

 

3. 끝

---