Convention - NariP/modoo-todo GitHub Wiki

Workflow

1. ์ด์Šˆ ์ƒ์„ฑ

  • github repository์— ๊ฐœ๋ฐœํ•  ๋‹จ์œ„์— ํ•ด๋‹นํ•˜๋Š” ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•œ๋‹ค
  • ์ด์Šˆ ์ƒ์„ฑ ์ปจ๋ฒค์…˜
    • ์ œ๋ชฉ
      • [๋Œ€๋ถ„๋ฅ˜]์†Œ๋ถ„๋ฅ˜: ์ž‘์—… ๋‚ด์šฉ
      • e.g. [Page]Todo: UI ์ถ”๊ฐ€
    • ๋‚ด์šฉ
      ### Details
      - ์ž‘์—…ํ•  ๋‚ด์šฉ
      - ์ž‘์—…ํ•  ๋‚ด์šฉ
      ...
      

2. ์ด์Šˆ์— ๋งž๋Š” ๊ธฐ๋Šฅ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ

3. Pull Request

  • PR ์ œ๋ชฉ์€ commit ์ปจ๋ฒค์…˜ ํ˜•์‹๊ณผ ๋™์ผ
  • ์ž‘์—…ํ•œ ์ด์Šˆ๋ฅผ closes๋กœ ๋‹ซ๋Š”๋‹ค.
    • closes #{์ด์Šˆ ๋ฒˆํ˜ธ}
  • ์ž‘์—… ๋‚ด์šฉ์„ ์ ๋Š”๋‹ค.
  • Labels, Assignees, Reviewers ๊นŒ๋จน์ง€ ๋ง๊ณ  ์ถ”๊ฐ€ํ•œ๋‹ค.
  • ์˜ˆ์‹œ 1(์—ฐ๊ฒฐ๋œ ์ด์Šˆ ๋ฒˆํ˜ธ: 2)
feature: ๋ณธ๋ฌธ, ์ถ”๊ฐ€ ๋‚ด์šฉ ์ปดํฌ๋„ŒํŠธ ๊ฐœ๋ฐœ

### ์ž‘์—… ๋‚ด์šฉ
- ๊ฒŒ์‹œ๊ธ€ ๋ณธ๋ฌธ ์ปดํฌ๋„ŒํŠธ ๊ฐœ๋ฐœ
- ๊ฒŒ์‹œ๊ธ€ ์ถ”๊ฐ€ ๋‚ด์šฉ ์ปดํฌ๋„ŒํŠธ ๊ฐœ๋ฐœ
- ๊ฒŒ์‹œ๊ธ€ ๋ ˆ์ด์•„์›ƒ ๊ฐœ๋ฐœ

closes #2

Commit Message Guideline

type: Subject #(์ด์Šˆ๋ฒˆํ˜ธ)
(๊ณต๋ฐฑ)
body
  • ๐Ÿ’ก Subject, body ์ฒซ ๊ธ€์ž๋Š” ๋Œ€๋ฌธ์ž
  • ๐Ÿ’ก ํ•œ๊ธ€ ์‚ฌ์šฉ ๊ฐ€๋Šฅ
  • TYPE
    • feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
    • fix: ๋ฒ„๊ทธ ์ˆ˜์ •
    • design: CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
    • style: ์ฝ”๋“œ ํฌ๋งท ๋ณ€๊ฒฝ e.g. ์„ธ๋ฏธ ์ฝœ๋ก  ๋ˆ„๋ฝ
    • refactor: ๋ฆฌํŒฉํ† ๋ง
    • docs: ๋ฌธ์„œ๋ฅผ ์ˆ˜์ •