Team Rules - codestates/nodongu-server GitHub Wiki

Team Coco's Rules

Pull Request ํ˜•์‹

  • [Client] / nickname / CRUD: ๋‚ด์šฉ ex) [Client] / quokka / update: Readme

Merge๋Š” ํ‰์ผ ์˜ค์ „ 10์‹œ, ์˜คํ›„ 6์‹œ ํ•˜๋ฃจ ๋‘๋ฒˆ ๊ทœ์น™์ ์œผ๋กœ ์‹คํ–‰ => ๋ฐœ์ƒ ํ•  ์ˆ˜ ์žˆ๋Š” conflict ์ตœ์†Œํ™”
๋‹จ, ํ•„์š”์— ์˜ํ•ด ํŒ€ ๋‚ด ๊ณต์ง€ ํ›„ ์›ํ•˜๋Š” ์‹œ๊ฐ„์— merge ๊ฐ€๋Šฅ

Commit Message ํ˜•์‹

  1. Fix
  • Fix A

A๋ฅผ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.

  • Fix A in B

B์˜ A๋ฅผ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.

  • Fix A to B

B๋ฅผ ์œ„ํ•ด A๋ฅผ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.

  1. Add
  • Add A

A๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

  • Add A for B

B๋ฅผ ์œ„ํ•ด A๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

  • Add A to B

B์— A๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

  1. Remove
  • Remove A

A๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.

  • Remove A from B

B์—์„œ A๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.

  1. Use
  • Use A

A๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

  1. Refactor
  • Refactor A

A๋ฅผ ์ „๋ฉด ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.

  1. Simplify
  • Simplify A

A๋ฅผ ๋‹จ์ˆœํ™” ํ•ฉ๋‹ˆ๋‹ค.

  1. Update
  • Update A to B

A๋ฅผ B๋กœ ์—…๋ฐ์ดํŠธ ํ•ฉ๋‹ˆ๋‹ค.

** ์ถ”๊ฐ€์„ค๋ช… ํ•„์š”์‹œ ์—ฌ๋Ÿฌ ๋ผ์ธ์œผ๋กœ ์ค„๋ฐ”๊ฟˆํ•˜์—ฌ ์ž‘์„ฑํ•  ๊ฒƒ **
** ํ•œ๊ตญ์–ด / ์˜์–ด ํ˜ผ์šฉ ๊ฐ€๋Šฅ **
** Remote dev branch์—๋„ ๊ผญ ํ‘ธ์‰ฌํ•˜๊ธฐ (๋ฐฑ์—…์šฉ) **
์ฐธ๊ณ ์‚ฌ์ดํŠธ

Isuue ํ˜•์‹

[์‚ฌ์ „์กฐ๊ฑด] Issue ํ•ด๊ฒฐ์— ํ•„์š”ํ•œ ์‚ฌ์ „ ์š”๊ฑด ๊ธฐ์žฌ โ€จ[์ ˆ์ฐจ] ํ•ด๋‹น issue๊ฐ€ ๋ฐœํ˜„๋˜๊ธฐ ์ „๊นŒ์ง€์˜ flow ๊ธฐ์žฌ

Ex)

  1. ๊ด€๋ฆฌ์ž ๋กœ๊ทธ์ธ
  2. ๋Œ€์‹œ๋ณด๋“œ > ๊ฐ€์ƒ๋ฆฌ์†Œ์Šค ํ˜„ํ™ฉ > ์ž‘์—…๋ช… ์„ ํƒ
  3. ๊ฐ€์ƒํ™” ์„œ๋น„์Šค > ๊ฐ€์ƒ ์„œ๋ฒ„ > ๋ณด์•ˆ๊ทธ๋ฃน ํ™”๋ฉด ์ง„์ž…
  4. ๋ณด์•ˆ๊ทธ๋ฃน๋ช… ์„ ํƒ
  5. ๊ทœ์น™ ์ˆ˜์ •๊ฐ€๋Šฅ ์—ฌ๋ถ€ ํ™•์ธ โ€จ[์ˆ˜ํ–‰๊ฒฐ๊ณผ] Issue ํ•ด๊ฒฐ์„ ์œ„ํ•œ ์‹ค์งˆ์ ์ธ ํ•ด๊ฒฐ์ฑ… ๊ธฐ์žฌ

[๊ธฐ๋Œ€์‚ฌํ•ญ] Issue ํ•ด๊ฒฐ ํ›„ ๊ธฐ๋Œ€๋˜๋Š” ์‚ฌํ•ญ ๊ธฐ์žฌ

branch ์ด๋ฆ„ ํ˜•์‹

  • feat / login
  • fix / readme

๋ณ€์ˆ˜ & ์ปดํฌ๋„ŒํŠธ ์ด๋ฆ„ (camelCase)

  • ex) clientLogin, userLogout ...

ํŒŒ์ผ & ์ƒ์„ฑ์ž ์ด๋ฆ„ (PascalCase)

  • ex) SuperFood, RealBBang ...

Node & Npm Version

  • node: v14.17.1
  • npm: v6.14.13

Code style synchronization

  • Prettier
  • ESLint(์˜ˆ์ •)

๊ทธ ์™ธ ๊ทœ์น™

  • ํ‰์ผ 10์‹œ, 18์‹œ ๋‘ ์ฐจ๋ก€์— ๊ฑธ์ณ Merge ์ง„ํ–‰
  • ๋‹ค๋ฅธ ํŒ€์›์—๊ฒŒ ์š”์ฒญ ์‚ฌํ•ญ์ด ์žˆ๋Š” ๊ฒฝ์šฐ, ๋””์Šค์ฝ”๋“œ / ์ด์Šˆ์นด๋“œ ๋“ฑ์„ ํ†ตํ•˜์—ฌ ์ „๋‹ฌ
  • ์ €๋… ์‹œ๊ฐ„์€ 18์‹œ-20์‹œ๋กœ ์„ค์ •
  • 50๋ถ„ ์ฝ”๋”ฉ, 10๋ถ„ ํœด์‹ ๊ถŒ์žฅ
โš ๏ธ **GitHub.com Fallback** โš ๏ธ