Skip to content

jeromwolf/development_guidelines

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 
ย 
ย 

Repository files navigation

Development Guidelines

ํ”„๋กœ์ ํŠธ ๊ฐœ๋ฐœ ๊ฐ€์ด๋“œ๋ผ์ธ ๋ชจ์Œ

๐Ÿ“‹ ๊ฐ€์ด๋“œ๋ผ์ธ ๋ฌธ์„œ

์ฃผ์š” ํŠน์ง• ๋ฐ ์žฅ์ 

๐Ÿ”’ ๊ฐœ์ธ์ •๋ณด ๋ณดํ˜ธ ์ตœ์šฐ์„ 
  • ๋ชจ๋“  ๋กœ๊ทธ์—์„œ ๊ฐœ์ธ์ •๋ณด ์ž๋™ ๋งˆ์Šคํ‚น
  • ์ด๋ฉ”์ผ, ์ „ํ™”๋ฒˆํ˜ธ, ์นด๋“œ๋ฒˆํ˜ธ ๋“ฑ ๋ฏผ๊ฐ ์ •๋ณด ํŒจํ„ด ์ž๋™ ๊ฐ์ง€ ๋ฐ ์ œ๊ฑฐ
  • ์•ˆ์ „ํ•œ ์ต๋ช… ์‹๋ณ„์ž ์ƒ์„ฑ ์‹œ์Šคํ…œ
  • GDPR ๋ฐ ๊ฐœ์ธ์ •๋ณด๋ณดํ˜ธ๋ฒ• ์ค€์ˆ˜
๐Ÿ“Š ์ฒด๊ณ„์ ์ธ ๋กœ๊น… ์ „๋žต
  • 8๋‹จ๊ณ„ ๋กœ๊ทธ ๋ ˆ๋ฒจ ์‹œ์Šคํ…œ (CRITICAL, ERROR, WARN, INFO, DEBUG, TRACE, AUDIT, BUSINESS)
  • ๊ตฌ์กฐํ™”๋œ JSON ๊ธฐ๋ฐ˜ ๋กœ๊น…์œผ๋กœ ํšจ์œจ์ ์ธ ๋ถ„์„
  • ์ง€๋Šฅํ˜• ๋กœ๊ทธ ๊ด€๋ฆฌ ๋ฐ AI ๊ธฐ๋ฐ˜ ํŒจํ„ด ๋ถ„์„
  • ์‹ค์‹œ๊ฐ„ ๋ชจ๋‹ˆํ„ฐ๋ง ๋ฐ ์•Œ๋ฆผ ์‹œ์Šคํ…œ
๐Ÿ›ก๏ธ ์ž๋™ํ™”๋œ ๋ณด์•ˆ ์‹œ์Šคํ…œ
  • ์‹ค์‹œ๊ฐ„ ๊ฐœ์ธ์ •๋ณด ํŒจํ„ด ์Šค์บ” ๋ฐ ์ œ๊ฑฐ
  • ์ž๋™ ๋กœ๊ทธ sanitization ๋ฏธ๋“ค์›จ์–ด
  • ์ปดํ”Œ๋ผ์ด์–ธ์Šค ์ž๋™ ๊ฒ€์ฆ ๋ฐ ๋ฆฌํฌํŠธ ์ƒ์„ฑ
  • ํ™˜๊ฒฝ๋ณ„ ์ฐจ๋ณ„ํ™”๋œ ๋กœ๊น… ์ •์ฑ…
๐Ÿ’ผ ์‹ค๋ฌด ์ ์šฉ ๊ฐ€๋Šฅํ•œ ์ฝ”๋“œ ์˜ˆ์‹œ
  • ์ฆ‰์‹œ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ JavaScript ์ฝ”๋“œ ์ƒ˜ํ”Œ
  • ๋กœ๊ทธ sanitizer ๊ตฌํ˜„์ฒด ์ œ๊ณต
  • ์•ˆ์ „ํ•œ ์‹๋ณ„์ž ์ƒ์„ฑ ํ•จ์ˆ˜ ํฌํ•จ
  • ์ปดํ”Œ๋ผ์ด์–ธ์Šค ์ฒด์ปค ๊ตฌํ˜„ ์˜ˆ์‹œ
๐Ÿ“ˆ ๋‹จ๊ณ„๋ณ„ ๋ฐ์ดํ„ฐ ์ „๋žต
  • ๋”๋ฏธ ๋ฐ์ดํ„ฐ์—์„œ ์‹ค์ œ ๋ฐ์ดํ„ฐ๋กœ์˜ ์ฒด๊ณ„์  ์ „ํ™˜ ๊ฐ€์ด๋“œ
  • ๊ฐœ๋ฐœ ๋‹จ๊ณ„๋ณ„ ๋ช…ํ™•ํ•œ ๋ฐ์ดํ„ฐ ์‚ฌ์šฉ ๊ธฐ์ค€
  • ๋”๋ฏธ ๋ฐ์ดํ„ฐ ์˜์กด์„ฑ ๋ฐฉ์ง€ ์ „๋žต
  • ๋ฐ์ดํ„ฐ ํ’ˆ์งˆ ๊ฒ€์ฆ ์ฒดํฌ๋ฆฌ์ŠคํŠธ
โœ… ์‹ค์šฉ์ ์ธ ์ฒดํฌ๋ฆฌ์ŠคํŠธ
  • ํ”„๋กœ๋•์…˜ ๋ฐฐํฌ ์ „ ์ž๋™ ๊ฒ€์ฆ ํ•ญ๋ชฉ
  • ์ฝ”๋“œ ๋ฆฌ๋ทฐ ์ฒดํฌํฌ์ธํŠธ
  • ๊ฐœ๋ฐœ ๋‹จ๊ณ„๋ณ„ ๊ฒ€์ฆ ๋ชฉ๋ก
  • ๋ฐ์ดํ„ฐ ์ „ํ™˜ ์ฒดํฌ๋ฆฌ์ŠคํŠธ
๐Ÿ”„ ์ง€์†์  ๊ฐœ์„  ํ”„๋กœ์„ธ์Šค
  • ์ •๊ธฐ์ ์ธ ๋กœ๊ทธ ์Šค์บ” ๋ฐ ๊ฐœ์„ 
  • ๋ฉ”ํŠธ๋ฆญ ๊ธฐ๋ฐ˜ ์„ฑ๋Šฅ ๋ชจ๋‹ˆํ„ฐ๋ง
  • ์ž๋™ํ™”๋œ ์ปดํ”Œ๋ผ์ด์–ธ์Šค ํ™•์ธ
  • ํŒ€ ํšŒ๊ณ  ๋ฐ ํ”„๋กœ์„ธ์Šค ๊ฐœ์„  ๊ฐ€์ด๋“œ

ํ™œ์šฉ ๋ฐฉ์•ˆ

  • ์‹ ๊ทœ ํ”„๋กœ์ ํŠธ: ์ดˆ๊ธฐ ์„ค๊ณ„๋ถ€ํ„ฐ ๊ฐœ์ธ์ •๋ณด ๋ณดํ˜ธ ์ ์šฉ
  • ๊ธฐ์กด ํ”„๋กœ์ ํŠธ: ๋ ˆ๊ฑฐ์‹œ ๋กœ๊น… ์‹œ์Šคํ…œ ๊ฐœ์„ 
  • ๊ฐ์‚ฌ ๋Œ€์‘: ๊ทœ์ • ์ค€์ˆ˜ ์ฆ๋ช… ์ž๋ฃŒ๋กœ ํ™œ์šฉ
  • ํŒ€ ๊ต์œก: ๊ฐœ๋ฐœํŒ€ ๋ณด์•ˆ ์ธ์‹ ํ–ฅ์ƒ ๊ต์œก ์ž๋ฃŒ

๐Ÿš€ ์‹œ์ž‘ํ•˜๊ธฐ

# ์ €์žฅ์†Œ ํด๋ก 
git clone https://github.com/jeromwolf/development_guidelines.git

# ๊ฐ€์ด๋“œ๋ผ์ธ ํ™•์ธ
cat logging_privacy_protection_guidelines.md

๐Ÿ“ ๊ธฐ์—ฌํ•˜๊ธฐ

๊ฐ€์ด๋“œ๋ผ์ธ ๊ฐœ์„  ์ œ์•ˆ์ด๋‚˜ ์ƒˆ๋กœ์šด ๊ฐ€์ด๋“œ๋ผ์ธ ์ถ”๊ฐ€๋ฅผ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค. PR์„ ๋ณด๋‚ด์ฃผ์„ธ์š”!

๐Ÿ“„ ๋ผ์ด์„ ์Šค

MIT License

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors