Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

๐Ÿš€[PR]: docs readme ์ตœ์‹ ํ™” #14

Merged
merged 4 commits into from
Jan 1, 2025
Merged

๐Ÿš€[PR]: docs readme ์ตœ์‹ ํ™” #14

merged 4 commits into from
Jan 1, 2025

Conversation

Tagite
Copy link
Owner

@Tagite Tagite commented Jan 1, 2025

๐Ÿš€ Pull Request (PR)

โœจ ๋ณ€๊ฒฝ ๋‚ด์šฉ

  • CLI ์‹คํ–‰ํ™˜๊ฒฝ ์ถ”๊ฐ€
  • README ์„ค์น˜๋ฐฉ๋ฒ•, ์‚ฌ์šฉ๋ฐฉ๋ฒ• ์ถ”๊ฐ€*

๐Ÿ› ๏ธ ๊ตฌํ˜„ ์ƒ์„ธ

  • ๊ตฌํ˜„ํ•œ ๋‚ด์šฉ์˜ ์„ธ๋ถ€ ์‚ฌํ•ญ:
    1. README ์—…๋ฐ์ดํŠธ
    2. Typer์˜์กด์„ฑ ์ถ”๊ฐ€ ๋ฐ main์— ์ฝ”๋“œ ์ถ”๊ฐ€

โœ… ์ฒดํฌ๋ฆฌ์ŠคํŠธ

  • ์ฝ”๋“œ๊ฐ€ ์˜ฌ๋ฐ”๋ฅด๊ฒŒ ๋™์ž‘ํ•˜๋Š”์ง€ ํ…Œ์ŠคํŠธ๋ฅผ ์™„๋ฃŒํ–ˆ์Šต๋‹ˆ๋‹ค.
  • Self-review๋ฅผ ์ง„ํ–‰ํ–ˆ์Šต๋‹ˆ๋‹ค.
  • ๊ด€๋ จ ๋ฌธ์„œ๋ฅผ ์—…๋ฐ์ดํŠธํ–ˆ์Šต๋‹ˆ๋‹ค.
  • ๋ชจ๋“  ๋ฆฌ๋ทฐ ์ฝ”๋ฉ˜ํŠธ๋ฅผ ๋ฐ˜์˜ํ–ˆ์Šต๋‹ˆ๋‹ค. (ํ•ด๋‹น ์‚ฌํ•ญ์ด ์žˆ์„ ๊ฒฝ์šฐ)

๐Ÿงช ํ…Œ์ŠคํŠธ ๊ฒฐ๊ณผ

  • ์–ด๋–ค ํ…Œ์ŠคํŠธ๋ฅผ ์ˆ˜ํ–‰ํ–ˆ๋‚˜์š”? (์„ ํƒ ์‚ฌํ•ญ):
    • ์˜ˆ: ์œ ๋‹› ํ…Œ์ŠคํŠธ, ํ†ตํ•ฉ ํ…Œ์ŠคํŠธ, ์ˆ˜๋™ ํ…Œ์ŠคํŠธ ๋“ฑ
    • ํ…Œ์ŠคํŠธ ๊ฒฐ๊ณผ๋ฅผ ๊ฐ„๋‹จํžˆ ์ ์–ด์ฃผ์„ธ์š”.

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

  • ๋ณ€๊ฒฝ๋œ ๋‚ด์šฉ๊ณผ ๊ด€๋ จ๋œ ์Šคํฌ๋ฆฐ์ƒท์„ ์ฒจ๋ถ€ํ•ด์ฃผ์„ธ์š”.

๐Ÿ”— ๊ด€๋ จ ์ด์Šˆ (์„ ํƒ ์‚ฌํ•ญ)

๐Ÿ“š ์ถ”๊ฐ€ ์ •๋ณด (์„ ํƒ ์‚ฌํ•ญ)

  • ๋ณ€๊ฒฝ ๋‚ด์šฉ๊ณผ ๊ด€๋ จ๋œ ์ถ”๊ฐ€์ ์ธ ์„ค๋ช…์ด ์žˆ๋‹ค๋ฉด ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.

Tagite added 4 commits January 1, 2025 21:42
@Tagite
โž•build(lock,toml) : add dependency typer
2a0a581 
typer๋ฅผ ์„ค์น˜ํ•˜์—ฌ cli๋กœ ๋™์ž‘ํ•˜๊ฒŒ ์ˆ˜์ •

ref: #9
@Tagite
โœจ feat(main) : add cli typer
a17c566 
cli๋กœ ์‹คํ–‰ํ•  ์ˆ˜ ์žˆ๋„๋ก typer๋ฅผ ์ ์šฉ

ref: #9
@Tagite
๐Ÿ“ docs(README) : update install & usage
f4918ed 
์„ค์น˜๋ฐฉ๋ฒ•๊ณผ ์‹คํ–‰๋ฐฉ๋ฒ•์„ ์ถ”๊ฐ€ํ•˜์˜€์Šต๋‹ˆ๋‹ค

ref: #9
@Tagite
๐ŸŽจ style(main) : comply ruff format
1888326 
ruffํฌ๋งท์— ๋งž๊ฒŒ ํฌ๋งคํŒ…
@Tagite Tagite added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 1, 2025
@Tagite Tagite self-assigned this Jan 1, 2025
@Tagite Tagite linked an issue Jan 1, 2025 that may be closed by this pull request
๐Ÿ“š[Docs]: README ์ตœ์‹ ํ™” #9
Closed
@Tagite Tagite merged commit e47b0bf into dev Jan 1, 2025
5 checks passed
@Tagite Tagite deleted the feature/9-docs-readme-์ตœ์‹ ํ™” branch January 5, 2025 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@Tagite Tagite

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

๐Ÿ“š[Docs]: README ์ตœ์‹ ํ™”
1 participant
@Tagite