search

kefranabg / readme-md-generator

📄 CLI that generates beautiful README.md files
https://www.npmjs.com/package/readme-md-generator
MIT License
10.9k stars 1.37k forks source link

Add changelog section #205

Open JuroOravec opened 4 years ago

JuroOravec commented 4 years ago

Is your feature request related to a problem? Please describe. It is useful to include a changelog in projects (see Keep a Changelog). Maybe this could be encouraged by including it in the generator?

Describe the solution you'd like Add a question that asks for changelog URL, and add a changelog section to the README if the URL was provided. The changelog section would be short and just point to the URL provided, similarly as done in Contributing section.

Describe alternatives you've considered User can either decide not to include it, but that's not very community-friendly. Or user can add the changelog section manually. However, changelog is applicable to likely the large majority of projects that use this generator, so it could be meaningful enough to provide it out of the box.

Additional context None

Mousticke commented 3 years ago

Hi, I find that feature really interesting. Are you working on it ? Or can I be assigned to that issue please ?

Thank you