πŸˆβ€β¬› Pull Request Template

유영·2023λ…„ 8μ›” 15일

πŸ“‚ Pull Request

πŸ“Œ νŠΉμ§•

Pull RequestλŠ” μ½”λ“œ λ³€κ²½ 사항을 μš”μ²­ν•˜κ³  κ²€ν† ν•˜λŠ” ν”„λ‘œμ„ΈμŠ€μž…λ‹ˆλ‹€.

  • λ‹€λ₯Έ νŒ€μ›λ“€μ΄ μ½”λ“œ λ³€κ²½ 사항을 κ²€ν† ν•˜κ³  ν”Όλ“œλ°±μ„ μ œκ³΅ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
  • 버그λ₯Ό 사전에 λ°œκ²¬ν•˜μ—¬ μˆ˜μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
  • μ½”λ“œ μΆ©λŒμ„ μ΅œμ†Œν™”ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
  • λ³€κ²½ 사항 수락이 기둝에 남아 ν”„λ‘œμ νŠΈμ˜ 버전 관리와 역사λ₯Ό 좔적할 수 μžˆμŠ΅λ‹ˆλ‹€.

πŸ“Œ μ£Όμš” 단계

  1. Branch 생성: μƒˆλ‘œμš΄ κΈ°λŠ₯ μΆ”κ°€, 버그 μˆ˜μ •κ³Ό 같은 νŠΉμ • μž‘μ—…μ„ μœ„ν•œ 브랜치λ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.
  2. μ½”λ“œ λ³€κ²½: μƒˆλ‘œμš΄ μ½”λ“œ μΆ”κ°€, κΈ°μ‘΄ μ½”λ“œ μˆ˜μ •, 파일 μ‚­μ œ λ“±μ˜ μž‘μ—…μ„ μˆ˜ν–‰ν•©λ‹ˆλ‹€.
  3. Commit: λ³€κ²½ 사항을 μž‘μ€ λ‹¨μœ„λ‘œ λ‚˜λˆ„μ–΄ commit ν•©λ‹ˆλ‹€. 이 λ•Œ commit messageλ₯Ό 톡해 λ³€κ²½ 사항을 확인할 수 μžˆλ„λ‘ ν•©λ‹ˆλ‹€.
  4. Push: λΈŒλžœμΉ˜μ—μ„œ μž‘μ—…ν•œ λ‚΄μš©λ“€μ„ 리λͺ¨νŠΈ μ €μž₯μ†Œ(GitHub / GitLab)에 pushν•˜μ—¬ κ³΅μœ ν•©λ‹ˆλ‹€. push 된 λ‚΄μš©μ€ νŒ€μ›λ“€μ΄ 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.
  5. Pull Request 생성: λ³€κ²½ 사항을 κΈ°μ‘΄ μ½”λ“œ λ² μ΄μŠ€μ™€ λ³‘ν•©ν•˜κΈ° μœ„ν•œ pull requestλ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.
  6. 리뷰: λ³€κ²½ 사항을 λ‹€λ₯Έ νŒ€μ›λ“€μ΄ κ²€ν† ν•©λ‹ˆλ‹€. 이 κ³Όμ •μ—μ„œμ˜ νŒ€μ›λ“€μ˜ μ˜κ²¬μ„ λ°˜μ˜ν•˜μ—¬ μ½”λ“œλ₯Ό μ—…λ°μ΄νŠΈν•  수 μžˆμŠ΅λ‹ˆλ‹€.
  7. 병합(Merge): 리뷰가 μ™„λ£Œ 되고 λ³€κ²½ 사항이 승인 되면 λ³€κ²½ μ½”λ“œμ™€ κΈ°μ‘΄ μ½”λ“œ 베이슀λ₯Ό λ³‘ν•©ν•©λ‹ˆλ‹€.

πŸ“‚ Pull Request Tamplate

πŸ“Œ νŠΉμ§•

Pull Request Template은 Pull Requestλ₯Ό 생성할 λ•Œ 미리 μ •μ˜λœ 양식을 μ‚¬μš©ν•˜λŠ” κΈ°λŠ₯μž…λ‹ˆλ‹€.

  • λͺ¨λ“  Pull Requestκ°€ μΌμ •ν•œ ν˜•μ‹κ³Ό λ‚΄μš©μ„ κ°€μ§ˆ 수 μžˆμŠ΅λ‹ˆλ‹€.
  • ν•„μš”ν•œ μ •λ³΄λ‚˜ μš”κ΅¬ 사항을 미리 μ •μ˜ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
  • 리뷰어듀이 ν•„μš”ν•œ 정보λ₯Ό μ‰½κ²Œ ν™•μΈν•˜κ³  λΉ λ₯΄κ²Œ κ²€ν† ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

βš™οΈ GitHubμ—μ„œμ˜ 생성 방법

  1. νŠΉμ • repository의 Code νƒ­μœΌλ‘œ μ΄λ™ν•©λ‹ˆλ‹€.
  2. 였λ₯Έμͺ½ μƒλ‹¨μ˜ Add file β†’ Create new file을 μ„ νƒν•©λ‹ˆλ‹€.
    create_new_file
  3. pull_request_template.md νŒŒμΌμ„ 생성해 μ€λ‹ˆλ‹€. 파일 μœ„μΉ˜λŠ” μ‚¬μš©μž μ§€μ •μ΄λ‚˜, .github 디렉토리에 μ €μž₯ν•˜λŠ” 것이 μΌλ°˜μ μž…λ‹ˆλ‹€.

βš™οΈ μ‚¬μš©ν•  Pull Request Template μ˜ˆμ‹œ

## 🧰 λ³€κ²½ νƒ€μž…
* [x] 🀹 FEATURE	: κΈ°λŠ₯ μΆ”κ°€  
* [ ] πŸ”§ FIX		: 버그 μˆ˜μ •  
* [ ] πŸ—‘οΈ DELETE	: 파일 μ‚­μ œ  
* [ ] 🎨 DESIGN	: λ””μžμΈ μž‘μ—…  
* [ ] πŸ’¬ COMMENT	: 주석 μž‘μ„±  
* [ ] πŸ“„ DOCS 	: λ¬Έμ„œ μž‘μ—…  

## βœ’οΈ λ³€κ²½ λ‚΄μš©
* 여기에 μž‘μ„±

## πŸ“’ 주의 및 리뷰 μš”μ²­
* 여기에 μž‘μ„±
profile
不ζ₯下問 =͟͟͞͞➳β₯

0개의 λŒ“κΈ€