Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Team-Pickify/backend

Repository files navigation

๐Ÿ“ Team-Pickify ๊ฐœ๋ฐœ ์ปจ๋ฒค์…˜

โญ๏ธ git issue Convention

  • ์ด์Šˆ ์ƒ์„ฑ ์‹œ ์ง„ํ–‰ํ•˜๊ณ ์ž ํ•˜๋Š” task์— ๋งž์ถฐ์„œ Get started
  • ์ด์Šˆ title: [ํƒ€์ž…] + ์‹ค์ œ ์ˆ˜ํ–‰ํ•  task ๋ชฉ๋ก
     ex) [Feat] API ์‘๋‹ต base code ๊ตฌํ˜„
    
  • ์ด์Šˆ description: ์ง„ํ–‰ํ•œ task ์ž์œ ๋กญ๊ฒŒ ์š”์•ฝ
  • Development์˜ Create a branch๋กœ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ
    • [ํƒ€์ž…]/#์ด์Šˆ๋ฒˆํ˜ธ
     ex) feature/#5
    

โญ๏ธ PR Convention

๐ŸŸข ๊ฐ ๋ธŒ๋žœ์น˜์—์„œ main์œผ๋กœ PR ์˜ฌ๋ฆฌ๊ธฐ
๐ŸŸข PR ์ƒ์„ฑ ํ›„ ํŒ€์› 2๋ช… ์ด์ƒ์—๊ฒŒ ์ฝ”๋“œ ๋ฆฌ๋ทฐ ๋ฐ›์•„์•ผ merge ๊ฐ€๋Šฅ
๐ŸŸข PR ๋‚ด์šฉ์€ ์•„๋ž˜์˜ ํ…œํ”Œ๋ฆฟ์„ ์‚ฌ์šฉํ•œ๋‹ค

#๏ธโƒฃ ์—ฐ๊ด€๋œ ์ด์Šˆ

ex) #์ด์Šˆ๋ฒˆํ˜ธ, #์ด์Šˆ๋ฒˆํ˜ธ

๐Ÿ“ ์ž‘์—… ๋‚ด์šฉ

์ด๋ฒˆ PR์—์„œ ์ž‘์—…ํ•œ ๋‚ด์šฉ์„ ๊ฐ„๋žตํžˆ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”(์ด๋ฏธ์ง€ ์ฒจ๋ถ€ ๊ฐ€๋Šฅ)

๐Ÿ“ธ ์Šคํฌ๋ฆฐ์ƒท (์„ ํƒ)

๐Ÿ’ฌ ๋ฆฌ๋ทฐ ์š”๊ตฌ์‚ฌํ•ญ(์„ ํƒ)

๋ฆฌ๋ทฐ์–ด๊ฐ€ ํŠน๋ณ„ํžˆ ๋ด์ฃผ์—ˆ์œผ๋ฉด ํ•˜๋Š” ๋ถ€๋ถ„์ด ์žˆ๋‹ค๋ฉด ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”

ex) ๋ฉ”์„œ๋“œ XXX์˜ ์ด๋ฆ„์„ ๋” ์ž˜ ์ง“๊ณ  ์‹ถ์€๋ฐ ํ˜น์‹œ ์ข‹์€ ๋ช…์นญ์ด ์žˆ์„๊นŒ์š”?


โญ๏ธ Code Convention

โœ… ๋“ค์—ฌ์“ฐ๊ธฐ๋Š” 4์นธ
โœ… indent depth(๋“ค์—ฌ์“ฐ๊ธฐ)๋Š” ์ตœ๋Œ€ํ•œ 2๊นŒ์ง€ ๋งž์ถ”๋„๋ก(๋ฐ˜๋ณต๋ฌธ ๋‚จ์šฉ ๊ธˆ์ง€)
โœ… ํด๋ž˜์Šค๋ช…์€ PascalCase, ๋ฉ”์„œ๋“œ์™€ ๋ณ€์ˆ˜๋Š” camelCase
โœ… ์ฃผ์„ ์ž‘์„ฑ ์‹œ "ํด๋ž˜์Šค์™€ ๋ฉ”์„œ๋“œ"์—๋Š” Javadoc ์Šคํƒ€์ผ ์‚ฌ์šฉ

๐Ÿ’กExample
/**
 * ์‚ฌ์šฉ์ž ์ •๋ณด๋ฅผ ID๋กœ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.
 *
 * @param userId ์กฐํšŒํ•  ์‚ฌ์šฉ์ž์˜ ID
 * @return ์‚ฌ์šฉ์ž ์ •๋ณด
 */

โœ… ์ฝ”๋“œ ๋‚ด ์ฃผ์„์€ ํ•„์š” ์‹œ ์ถ”๊ฐ€, ๋ถˆํ•„์š”ํ•œ ์ฃผ์„์€ ์ œ๊ฑฐ


โญ๏ธ Spring Boot ํŠนํ™” ์ฝ”๋“œ ์Šคํƒ€์ผ

1. ์• ๋…ธํ…Œ์ด์…˜ ์‚ฌ์šฉ

  • ํด๋ž˜์Šค ๋ ˆ๋ฒจ์˜ ์• ๋…ธํ…Œ์ด์…˜ ์ˆœ์„œ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์ž‘์„ฑํ•œ๋‹ค
     1) @Controller, @Service, @Repository ๋“ฑ ์ฃผ์š” ์—ญํ•  ์ง€์ •
     2) @RequestMapping, @GetMapping, @PostMapping ๋“ฑ HTTP ๊ด€๋ จ ์• ๋…ธํ…Œ์ด์…˜
     3) ๊ธฐํƒ€(์˜ˆ: @Transactional, @Cacheable)
    

2. Bean ์ฃผ์ž… ๋ฐฉ์‹

  • Spring์—์„œ๋Š” ์ƒ์„ฑ์ž ์ฃผ์ž…์„ ๊ธฐ๋ณธ์œผ๋กœ ์‚ฌ์šฉํ•˜๋ฉฐ, @Autowired ํ•„๋“œ ์ฃผ์ž…์€ ์ง€์–‘

3. ์ปจํŠธ๋กค๋Ÿฌ ๋ฉ”์„œ๋“œ

  • HTTP ์‘๋‹ต ์ฝ”๋“œ๋Š” ๋ช…ํ™•ํžˆ ์„ค์ •ํ•˜๊ณ , ๋ฐ˜ํ™˜ ํƒ€์ž…์œผ๋กœ๋Š” DTO ์‚ฌ์šฉ

4. DTO์™€ Entity ๋ถ„๋ฆฌ

  • DTO๋Š” ์™ธ๋ถ€์— ๋…ธ์ถœ๋˜๋Š” ๋ฐ์ดํ„ฐ๋ฅผ ์ •์˜ํ•˜๋ฉฐ, Entity๋Š” ๋‚ด๋ถ€ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค์™€ ๋งคํ•‘
  • Entity๋ฅผ ์ง์ ‘ ์ปจํŠธ๋กค๋Ÿฌ์—์„œ ๋ฐ˜ํ™˜ํ•˜์ง€ ๋ง๊ณ , ์„œ๋น„์Šค ๊ณ„์ธต์—์„œ ๋ณ€ํ™˜

About

๐Ÿ“ํ”ผํ‚คํŒŒ์ด: SNS ๊ธฐ๋ฐ˜ ํ•ซํ”Œ๋ ˆ์ด์Šค ์ถ”์ฒœ ์„œ๋น„์Šค

Resources

Stars

Watchers

Forks

Contributors

AltStyle ใซใ‚ˆใฃใฆๅค‰ๆ›ใ•ใ‚ŒใŸใƒšใƒผใ‚ธ (->ใ‚ชใƒชใ‚ธใƒŠใƒซ) /