[github] git issue, project

AnSuebin·2022년 12월 23일
0

00. 들어가며

깃을 사용하지만, 협업을 하지 못했고, 다른 사람들의 코드를 제대로 보적도 많지 않다고 느꼈다.
매번 미뤄왔던 git issue와 project를 공부하고 이번주 클론 코딩에 적용해보려한다.

01. 깃 이슈, PR 템플릿 만들기

  • 우선 기본적인 github관련 폴더가 필요하다
  • .github폴더를 가장 상위에 만들어주고, 그 아래에 'PULL_REQUEST_TEMPLATE.md'라는 파일을 만들어 PR 템플릿 파일을 만들어준다.
  • 이 이후부터는 깃허브로 돌아와 템플릿 내용을 넣어준다.
## PR 체크사항
PR이 다음 사항을 만족하는지 확인해주세요.

- [ ] 커밋 메시지 작성 가이드라인
- [ ] 라벨, 담당자, 리뷰어 지정


## PR 타입
어떤 유형의 PR인지 체크해주세요.

<!-- 체크하려면 괄호 안에 "x"를 입력하세요. -->

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Documentation content changes
- [ ] Other... Please describe:


## PR 설명
내용을 적어주세요.


## 작업사항
- 내용을 적어주세요.


## 변경로직
- 내용을 적어주세요.
  • 깃이슈 템플릿은 셋팅에서 조금내리면 있는 Features에서 Set up templates를 클릭해준다.
  • 그리고 템플릿을 추가해준다.
  • issue--🐞bug-
---
name: bug
about: Create a report to help us improve
title: ''
labels: ''
assignees: suno0140

---

---
name: "Issue: \U0001F41EBUG"
about: Bug 발생 시 작성해주세요.
title: ''
labels: ''
assignees: ''

---

## Description
버그 내용을 작성하세요.


## 재현 과정
어떤 상황에 버그가 발생하는지 작성하세요.
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error


## 예상하는 정상 작동
정상 작동시 어떤 결과가 나와야 하는지 작성해주세요.


## 스크린샷
가능하다면 스크린샷을 첨부해주세요.


## 버그 환경
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

## ETC
  • issue--✔️feature-
---
name: 'Issue: ✔Feature '
about: Feature 작업 사항을 입력해주세요.
title: ''
labels: ''
assignees: ''

---

## Description
설명을 작성해주세요.


## Todo
- [ ] todo
- [ ] todo 

## Etc
기타사항
  • issue--💎refactor.
---
name: "Issue: \U0001F48ERefactor"
about: Refactor 작업 사항을 입력해주세요.
title: ''
labels: ''
assignees: ''

---

## Description
설명을 입력해주세요.


## Before
변경전의 상황과 변경하려는 이유를 작성해주세요.


## After
변경후의 예상하는 구조를 작성해주세요.


## Todo
- [ ] todo
- [ ] todo

## ETC

02. 이슈 만들기

  • 제목
    • 예) Feat : 내용
  • 내용
    • 구체적인 템플릿의 내용을 사용하여 작성
    • 기능과 연관된 해야할 일 todo로 작성
    • Assignees : 해당 작업의 담당자 (즉, 이슈의 작업자이다)
    • Labels : 해당 작업의 성격
    • Projects : 만든 Projects 중에서 하나를 선택
    • Milestone : 프로젝트가 도달해야 하는 목표 지점

03. 기능 만들기

  • 이슈 번호를 보고 brunch 제작
    • 예) feature/#3
  • 기능 작성 후, commit

04. pullrequest

  • 제목
    • 예) Feat : 내용
  • 내용
    • 구체적인 템플릿의 내용을 사용하여 작성
    • 기능과 연관된 해야할 일 todo로 작성
    • Assignees : 해당 작업의 담당자 (즉, 이슈의 작업자이다)
    • Labels : 해당 작업의 성격
    • Projects : 만든 Projects 중에서 하나를 선택
    • Milestone : 프로젝트가 도달해야 하는 목표 지점
  • 확인할 담당자에게 확인 요청
  • 담당자는 확인하고 리뷰 남겨주기

05. 이슈 닫아주기

  • 이슈에 들어가서 close 해준다!

참고자료

profile
고객에게 명료한 의미를 전달하고, 명료한 코드를 통해 생산성 향상에 기여하고자 노력합니다.

0개의 댓글