Skip to content

Latest commit

ย 

History

History
124 lines (83 loc) ยท 7.13 KB

README.md

File metadata and controls

124 lines (83 loc) ยท 7.13 KB

๐ŸŒŽ Babble

github_readme

๐Ÿš€ 1. Introduction

ํ‚ค์›Œ๋“œ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•œ ๋น ๋ฅธ ๊ฒŒ์ž„ ํŒ€ ๋งค์นญ ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค.

ํ•จ๊ป˜ ๊ฒŒ์ž„ํ•  ์‚ฌ๋žŒ์ด ํ•„์š”ํ•œ ์‚ฌ์šฉ์ž๋“ค์ด ํ‚ค์›Œ๋“œ๋ฅผ ํ†ตํ•ด ๋น ๋ฅด๊ฒŒ ํŒ€์„ ์ฐพ๊ณ , ๊ฒŒ์ž„์„ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.



์„ธ๋ถ€ ๊ธฐ๋Šฅ์„ ๋ณด๊ณ ์‹ถ๋‹ค๋ฉด? ์—ฌ๊ธฐ๋กœ!


๐Ÿ’š 2. About Us

๐Ÿ’š About Us

_ _ _ _ _ _
Back-End Back-End Back-End Back-End Front-End Front-End
๋ฃจํŠธ(๊น€์ค€๊ทผ)
๐Ÿ‘จโ€๐Ÿ’ป
์™€์ผ๋”(๊ฐ•๊ทœํ•œ)
๐Ÿ‘จโ€๐Ÿ’ป
ํฌ์ธˆ(์ •์œค์„ฑ)
๐Ÿ‘จโ€๐Ÿ’ป
ํ˜„๊ตฌ๋ง‰(์ตœํ˜„๊ตฌ)
๐Ÿ‘จโ€๐Ÿ’ป
๊ทธ๋ฃจ๋ฐ(๊ฐ•๋ฏผ๊ฒฝ)
๐Ÿ‘ฉโ€๐Ÿ’ป
ํ”ผํ„ฐ(์•ˆํ˜„์ฒ )
๐Ÿ‘จโ€๐Ÿ’ป
๋ฃจํŠธ ๋ธ”๋กœ๊ทธ ์™€์ผ๋” ๋ธ”๋กœ๊ทธ ํฌ์ธˆ ๋ธ”๋กœ๊ทธ ํ˜„๊ตฌ๋ง‰ ๋ธ”๋กœ๊ทธ ๊ทธ๋ฃจ๋ฐ ๋ธ”๋กœ๊ทธ ํ”ผํ„ฐ ๋ธ”๋กœ๊ทธ

babble์˜ ๊ธฐ์ˆ ์— ๋Œ€ํ•ด ๋” ์•Œ๊ณ ์‹ถ๋‹ค๋ฉด? Babble ๊ธฐ์ˆ  ๋ธ”๋กœ๊ทธ

babble ํŒ€์— ๋Œ€ํ•ด ๋” ์•Œ๊ณ  ์‹ถ๋‹ค๋ฉด? Babble WIKI


๐Ÿ’ป 3. Infra Structure

production-infra be-cicd fe-cicd


๐ŸŽ 4. Tech Stacks

tech-stack


๐Ÿ’Š 5. Conventions

Commit Message Format

๐Ÿชœ Items
  • feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ
  • fix: ๋ฒ„๊ทธ๋ฅผ ์ˆ˜์ •
  • refactor: ์ด๋ฏธ ์žˆ๋Š” ์ฝ”๋“œ์— ๋Œ€ํ•œ ๋ฆฌํŒฉํ† ๋ง
  • css: CSS ๊ด€๋ จ ์ˆ˜์ •
  • style: ์ฝ”๋“œ ํฌ๋งคํŒ…์— ๊ด€ํ•œ ์Šคํƒ€์ผ ๋ณ€๊ฒฝ
  • docs: Document ๋ณ€๊ฒฝ ์‚ฌํ•ญ
  • test: Test Code์— ๋Œ€ํ•œ commit
  • build: ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ • (์˜ˆ์‹œ scope: gulp, broccoli, npm)
  • perf: ์„ฑ๋Šฅ ๊ฐœ์„ ์‚ฌํ•ญ
  • ci: CI ์„ค์ • ํŒŒ์ผ ์ˆ˜์ • (์˜ˆ์‹œ scope: Circle, BrowserStack, SauceLabs)
  • chore: ๊ทธ ์™ธ์˜ ์ž‘์€ ์ˆ˜์ •๋“ค

  • Commit Message๋Š” ํ•œ๊ตญ์–ด๋ฅผ ์‚ฌ์šฉ
  • Angular JS Git Commit Message Conventions๋ฅผ ๋”ฐ๋ฅด๋˜, Scope๋Š” ๋ช…์‹œํ•˜์ง€ ์•Š์Œ

Issue

  • ํ•ด์•ผ ํ•  Task๋ฅผ ๋ฏธ๋ฆฌ Issue์— ๋“ฑ๋ก ํ›„ ๊ฐœ๋ฐœ

Pull Request

  • Issue์— ์˜ฌ๋ผ์˜จ Task๋ฅผ ๋๋‚ด๋ฉด, Pull Request๋ฅผ ํ†ตํ•ด ํŒ€์›๋“ค์˜ Review๋ฅผ ๋ฐ›์€ ํ›„, develop ๋ธŒ๋žœ์น˜์— merge ํ•จ

Branch Strategy

main

  • ์ œํ’ˆ์„ ์ตœ์ข…์ ์œผ๋กœ ๋ฐฐํฌํ•˜๋Š” ๋ธŒ๋žœ์น˜ (develop ๋ธŒ๋žœ์น˜๋กœ๋ถ€ํ„ฐ merge๋งŒ ๋ฐ›๋Š” ๋ธŒ๋žœ์น˜)
  • ๋ฐฐํฌ์— ์‚ฌ์šฉ๋จ

develop

  • ์•„์ง ๋ฐฐํฌ๋˜์ง€ ์•Š์€ ๊ณต์šฉ ๋ธŒ๋žœ์น˜
  • feature ๋ธŒ๋žœ์น˜๋กœ๋ถ€ํ„ฐ merge๋ฅผ ๋ฐ›๋Š”๋‹ค. ๊ฐœ๋ฐœ ์ค‘์— ๋ฒ„๊ทธ๋ฅผ ๋ฐœ๊ฒฌํ•˜๋ฉด ์ด ๋ธŒ๋žœ์น˜์— ์ง์ ‘ commitํ•จ

feature

  • ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ์„ ํ•˜๋Š” ๋ธŒ๋žœ์น˜
    • ๋ฐ˜๋“œ์‹œ develop ๋กœ๋ถ€ํ„ฐ ์‹œ์ž‘๋˜๊ณ , develop ๋ธŒ๋žœ์น˜์— ๋จธ์ง€ํ•จ
    • feature/๊ธฐ๋Šฅ์ด๋ฆ„ ex) feature/new-feature

realease

  • ์ตœ์ข… ๋ฐฐํฌ์ „, QA๋ฅผ ์ง„ํ–‰ํ•˜๋Š” ๋ธŒ๋žœ์น˜
  • ์•„์ง ๋ฐฐํฌ๋˜์ง€ ์•Š์€ ๊ณต์šฉ ๋ธŒ๋žœ์น˜
  • develop ๋ธŒ๋žœ์น˜๋กœ๋ถ€ํ„ฐ merge๋ฅผ ๋ฐ›๋Š”๋‹ค.

hotfix

  • ๋‹ค์Œ ๋ฐฐํฌ ์ „๊นŒ์ง€ ๊ธ‰ํ•˜๊ฒŒ ๊ณ ์ณ์•ผ๋˜๋Š” ๋ฒ„๊ทธ๋ฅผ ์ฒ˜๋ฆฌํ•˜๋Š” ๋ธŒ๋žœ์น˜
    • ๋ฐฐํฌ ๋ฒ„์ „ ์‹ฌ๊ฐํ•œ ๋ฒ„๊ทธ ์ˆ˜์ •์ด ํ•„์š”ํ•œ๊ฒฝ์šฐ, ๋ฒ„๊ทธ ์ˆ˜์ •์„ ์ง„ํ–‰ํ•œ๋’ค main, develop ๋ธŒ๋žœ์น˜์— mergeํ•จ
    • hotfix/๋ฒ„๊ทธ์ด๋ฆ„ ex) hotfix/bugs