0.0.2 โ€ข Published 1 year ago

@knu-k/readme-template-autogen v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

README Template Autogen ๐ŸŽ‰

npm version

readme-template-autogen์€ ๋‚ด๋ถ€์ ์œผ๋กœ ์กด์žฌํ•˜๋Š” ํ…œํ”Œ๋ฆฟ ๊ธฐ๋ฐ˜์œผ๋กœ ํ”„๋กœ์ ํŠธ์—์„œ ๋ณด๋‹ค ๋น ๋ฅด๊ฒŒ readme ๋ฅผ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ๊ฒŒ ํ•ด์ค€๋‹ค.

๐Ÿ“ฅ ์„ค์น˜

์ด ํ”„๋กœ์ ํŠธ๋Š” npm ํŒจํ‚ค์ง€๋กœ ๋ฐฐํฌ๋ฉ๋‹ˆ๋‹ค. ๋‹ค์Œ ๋ช…๋ น์–ด๋ฅผ ํ†ตํ•ด ์„ค์น˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค:

npm install -g @knu-k/readme-template-autogen

๐Ÿ“ ์‚ฌ์šฉ๋ฒ•

changelog-gen ๋ช…๋ น์–ด

์„ค์น˜ ํ›„, readme-template ๋ช…๋ น์–ด๋ฅผ ํ†ตํ•ด README.md ํŒŒ์ผ์„ ์ž๋™์œผ๋กœ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

readme-template init

๐Ÿค ๊ธฐ์—ฌ ๋ฐฉ๋ฒ•

์ด ํ”„๋กœ์ ํŠธ์— ๊ธฐ์—ฌํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด, ๋‹ค์Œ ๋‹จ๊ณ„๋ฅผ ๋”ฐ๋ผ ์ฃผ์„ธ์š”:

  1. ์ด ๋ฆฌํฌ์ง€ํ† ๋ฆฌ๋ฅผ ํฌํฌํ•ฉ๋‹ˆ๋‹ค.
  2. ์ƒˆ๋กœ์šด ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค (git checkout -b feature-branch).
  3. ๋ณ€๊ฒฝ ์‚ฌํ•ญ์„ ์ปค๋ฐ‹ํ•ฉ๋‹ˆ๋‹ค (git commit -am 'Add new feature').
  4. ๋ณ€๊ฒฝ ์‚ฌํ•ญ์„ ํ‘ธ์‹œํ•ฉ๋‹ˆ๋‹ค (git push origin feature-branch).
  5. Pull Request๋ฅผ ์ƒ์„ฑํ•˜์—ฌ ๊ธฐ์—ฌ๋ฅผ ์ œ์ถœํ•ฉ๋‹ˆ๋‹ค.

๋ชจ๋“  ๊ธฐ์—ฌ๋Š” ๊ธฐ์—ฌ ๊ฐ€์ด๋“œ๋ผ์ธ์— ๋”ฐ๋ผ ์ด๋ฃจ์–ด์ ธ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

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

์ด ํ”„๋กœ์ ํŠธ๋Š” MIT ๋ผ์ด์„ ์Šค ํ•˜์— ๋ฐฐํฌ๋ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ๋‚ด์šฉ์€ LICENSE ํŒŒ์ผ์„ ํ™•์ธํ•˜์„ธ์š”.

๐Ÿ‘จโ€๐Ÿ’ป ์ €์ž

  • KNU-K

์ด ํ”„๋กœ์ ํŠธ์— ๋Œ€ํ•œ ๋” ์ž์„ธํ•œ ์ •๋ณด๋Š” changelog-autogen GitHub ๋ฆฌํฌ์ง€ํ† ๋ฆฌ์—์„œ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

0.0.2

1 year ago

0.0.1

1 year ago

0.0.0

1 year ago