Home - nhnacademy-aiot3-4iren/4iren-wiki GitHub Wiki
๐ 4iren ํ๋ก์ ํธ ์๋ฃ์ค (Wiki)
๐ก ํ๋ก์ ํธ์ ๋ํ ์ ๋ฐ์ ์ธ ์๊ฐ์ ์คํ ๋ฐฉ๋ฒ์ **README.md**๋ฅผ ์ฐธ๊ณ ํด ์ฃผ์ธ์! ์ด๊ณณ์ 4iren ํ์ ๊ฐ๋ฐ ์ฐ์ถ๋ฌผ, ๊ธฐ์ ๋ฌธ์, ํ์๋ก์ ๋ชจ์๋๋ ๊ณต๊ฐ์ ๋๋ค.
๐ ์ฃผ์ ๋ฌธ์ (Navigation)
๐ ๊ธฐํ ๋ฐ ์ค๊ณ
๐ ๊ธฐ์ ๋ฌธ์
- API ๋ช ์ธ์- ์ ๋ฐ์ดํธ ์์
- ERD (๋ฐ์ดํฐ๋ฒ ์ด์ค ์ค๊ณ)
- ์์คํ ์ํคํ ์ฒ- ์ ๋ฐ์ดํธ ์์
- ์ด์/๋ชจ๋ํฐ๋ง ๊ฐ์ด๋
๐ค ํ ์ปจ๋ฒค์ ๋ฐ ๊ท์น
- GitFlow ๋ธ๋์น ์ ๋ต
- ์ปค๋ฐ ๋ฉ์์ง ๊ท์น
- Label๊ณผ ์ด์ํ์ ์๋ด
- ์ด์/PR ์ด๋ฆ(์ ๋ชฉ)๋ช ๋ช ๊ท์น
๐ ํ์๋ก
๐ข ํ์๋ก ์๋ ๋ฑ๋ก ์๋ด (ํ์ ํ๋ )
์ด์ ํ์๋ก์ Notion์๋ง ์์ฑํ๋ฉด GitHub ์ด์ โ ํ๋ก์ ํธ โ ์ด ์ํค ํ์ด์ง๊น์ง ์ ๋ถ ์๋์ผ๋ก ๋ฐ์๋ฉ๋๋ค. GitHub์ ์ง์ ์ด์๋ฅผ ๋ง๋ค ํ์ ์์ด์!
์ฌ์ฉ ๋ฐฉ๋ฒ
- Notion ํ์๋ก ๋ฐ์ดํฐ๋ฒ ์ด์ค์์ ํ์์ฒ๋ผ ๋ ์ง/๋ฏธํ ํ์ /์คํฌ๋ผ๋ง์คํฐ/์ฐธ์์/๋ด์ฉ์ ์์ฑํ๋ค.
- ๋ค ์์ฑํ์ผ๋ฉด "์๋ฃ" ์ฒดํฌ๋ฐ์ค๋ฅผ ์ผ ๋ค.
- ์ต๋ 15๋ถ ์์ ์๋์ผ๋ก GitHub ์ด์๊ฐ ์์ฑ๋๊ณ , ๋ผ๋ฒจ์ด ๋ถ๊ณ , ํ๋ก์ ํธ Scrum ๋ทฐ์ ์ด ํ์๋ก ํ์ด์ง์๋ ๋ฐ์๋๋ค.
์ฒดํฌ ์ดํ์ ๋ด์ฉ์ ๊ณ ์น๊ณ ์ถ๋ค๋ฉด
- ์ฒดํฌ๋ฐ์ค๋ฅผ ๊ทธ๋๋ก ๋ ์ฑ๋ก Notion ๋ด์ฉ๋ง ์์ ํ๋ฉด โ ๋ค์ ์๋ ์คํ ๋ ๊ฐ์ ์ด์๊ฐ ์ต์ ๋ด์ฉ์ผ๋ก ๊ฐฑ์ ๋ฉ๋๋ค. (์ ์ด์๊ฐ ๋ ์๊ธฐ์ง ์์์)
- ์ฒดํฌ๋ฅผ ๊ป๋ค๊ฐ ์์ ํ ๋ค์ ์ผ๋ ๊ฒฐ๊ณผ๋ ๋์ผํฉ๋๋ค. ๋ง์ฐฌ๊ฐ์ง๋ก ๊ธฐ์กด ์ด์๊ฐ ์ ๋ฐ์ดํธ๋ ๋ฟ, ์ค๋ณต ์์ฑ๋์ง ์์ต๋๋ค.
- ๋ด์ฉ์ด ์ค์ ๋ก ์ ๋ฐ๋์์ผ๋ฉด ์๋ํ๋ ์๋ฌด๊ฒ๋ ๊ฑด๋๋ฆฌ์ง ์์ต๋๋ค.
์ฃผ์ํ ์
- ์ฒดํฌ๋ฐ์ค๊ฐ ์ผ์ ธ ์๋ ๋์์ Notion์ด ์๋ณธ์ ๋๋ค. GitHub ์ด์ ๋ณธ๋ฌธ์ ์ง์ ์์ ํด๋, ๋ค์ ์๋ ์คํ ๋ Notion ๋ด์ฉ์ผ๋ก ๋ฎ์ด์จ์ง๋๋ค. ์ด์ ์์ฒด์ ๋ํ ๋ ผ์๋ ๋๊ธ๋ก ๋จ๊ฒจ์ฃผ์ธ์.
- ์ด์๊ฐ ๋ซํ(Closed) ๋ค์๋ ์๋ํ๊ฐ ๋ ์ด์ ๊ฑด๋๋ฆฌ์ง ์์ต๋๋ค. ์์ ํ๊ฒ ๋ณด์กด๋ฉ๋๋ค.
- "์คํฌ๋ผ๋ง์คํฐ"/"์ฐธ์์"๋ Notion ์ํฌ์คํ์ด์ค ๊ณ์ ์ด๋ฆ์ ๊ทธ๋๋ก ๊ฐ์ ธ์ต๋๋ค. ์ด๋ฆ์ด ์ด์ํ๊ฒ(์: ์ฑ/์ด๋ฆ ์์๊ฐ ๋ค๋ฐ๋์ด) ๋์จ๋ค๋ฉด ๋ณธ์ธ Notion ํ๋กํ ์ด๋ฆ์ ๊ณ ์ณ์ฃผ์ธ์.