diff --git a/planfit/README.md b/planfit/README.md new file mode 100644 index 0000000..f94e8b2 --- /dev/null +++ b/planfit/README.md @@ -0,0 +1,42 @@ +# πŸ’ͺ🏻 Planfit πŸ’ͺ🏻 +μš΄λ™μ΄ μ‰¬μ›Œμ§„λ‹€. ν”Œλžœν• ν•˜λ‚˜λ©΄ μš΄λ™ κ³ λ―Ό 끝. + +## Developers ✨ +| μ§„κ±΄μš° | 김채원 | κ³½μ„±μ€€ | +|--------------------------------------------------------------------------------------------------------------|------------|------------| +| | | | + + +## ERD πŸ—‚οΈ +![image](https://github.com/NOW-SOPT-APP3-PlanFit/PlanFit-SERVER/assets/113420297/7419007a-2f3c-4309-9ff0-37c4dd0c6b17) + +## API Specification πŸ“œ +### [API λͺ…μ„Έμ„œ λ°”λ‘œκ°€κΈ°](https://www.notion.so/sopt-official/94a128e2d9a1469e9d2c05a040481397?v=4ab2983f89474a3fae37f1d216001634&pvs=4)
+ +![image](https://github.com/NOW-SOPT-APP3-PlanFit/PlanFit-SERVER/assets/113420297/c8100f12-79da-43d0-a9b2-076ee0efd6b5)
+ +## Git Convention πŸ”— +### [Git Convention λ°”λ‘œκ°€κΈ°](https://www.notion.so/3-5509c144adaf437a956d68a03d392b1f?pvs=4#d46d255ee4fc4bf396b1c791a916d8c0)
+ + +### commit μ»¨λ²€μ…˜ + +``` +- **Feature** : κΈ°λŠ₯ μΆ”κ°€ +- **Fix** : μ—λŸ¬ μˆ˜μ •, 버그 μˆ˜μ • +- **Refactor** : μ½”λ“œ λ¦¬νŽ™ν† λ§ (κΈ°λŠ₯ λ³€κ²½ 없이 μ½”λ“œλ§Œ μˆ˜μ •ν•  λ•Œ) +- **Chore** : μ½”λ“œ μˆ˜μ • (κΈ°λŠ₯의 λ³€ν™”κ°€ μžˆμ„ λ•Œ) +- **Setting** : gradle μ„ΈνŒ…, μœ„μ˜ 것 이외에 거의 λͺ¨λ“  것 +- **Merge** : main 머지할 λ•Œ +``` + +> Commit +> +- ex) [Feat] λ­ν–ˆλŠ”μ§€(#이슈번호) + +> PR 제λͺ© +> +- ex) [FEAT] λ­ν–ˆλŠ”μ§€(#이슈번호) + +## Code Convention πŸ”— +### [Code Convention λ°”λ‘œκ°€κΈ°](https://www.notion.so/3-5509c144adaf437a956d68a03d392b1f?pvs=4#25f2f56c6da746be99f790c9c54604d6)
\ No newline at end of file